@hooksbase/sdk

TypeScript SDK for Hooksbase machine APIs, ingest publishing, and outbound webhook signature verification.

Install

npm install @hooksbase/sdk

Usage

import { createHooksbaseClient } from "@hooksbase/sdk";

const client = createHooksbaseClient({
  baseUrl: "https://api.hooksbase.com",
  apiKey: process.env.HOOKSBASE_API_KEY
});

const project = await client.projects.getCurrent();
console.log(project.id, project.name);

Starter+ projects can manage Automations when DYNAMIC_WORKERS_ENABLED=true. Code Mode transforms are the code-powered automation mode for delivery-path payload shaping:

const automation = await client.automations.create({
  webhookId: "wh_123",
  name: "Normalize inbound event",
  type: "transform"
});

const version = await client.automations.createVersion(automation.automation.id, {
  code: "export async function run(input) { return { type: 'dispatch', body: input.source.payload }; }",
  compatibilityFlags: ["nodejs_compat"]
});

await client.automations.activateVersion(automation.automation.id, version.version.id);
await client.automations.bindWebhook("wh_123", automation.automation.id);
await client.automationQuotas.getProject();
await client.automationBillingUsage.get({ month: "2026-05" });

const templates = await client.automationTemplates.list();
await client.automationTemplates.create(templates.items[0].id, {
  webhookId: "wh_123",
  activate: true
});

Enterprise project admins can also manage exact-host egress policies and gateway credentials:

const policy = await client.automationEgressPolicies.create({
  name: "CRM API",
  allowHosts: ["api.example.com"]
});

await client.automationEgressPolicies.createCredential(policy.policy.id, {
  name: "CRM token",
  host: "api.example.com",
  injectionType: "authorization_bearer",
  secret: process.env.CRM_API_TOKEN!
});

await client.automations.attachEgressPolicy(automation.automation.id, policy.policy.id);

The SDK includes:

• machine-route resources for projects, API keys, audit logs, HTTP packs, webhooks, webhook delivery lists, destinations, routing, classic transforms, Automations, Automation usage, Enterprise egress, templates, schedules, deliveries, replay jobs, bulk operations, DLQ, usage, event drains, operator notifications, alert channels, and alert rules
• Automation* type aliases alongside existing DynamicWorker* exported types for compatibility
• email allowlist helpers and signed/authenticated file download helpers
• public ingest helpers with idempotency and delayed-delivery header support
• form ingest remains browser/raw HTTP only
• cursor pagination helpers
• typed API and transport errors
• webhook signature verification helpers