TypeScript SDK

npm install @webhook-co/sdk

import { WebhookClient } from "@webhook-co/sdk";

const webhook = new WebhookClient({ apiKey: process.env.WEBHOOK_API_KEY! });

const endpoint = await webhook.endpoints.create({ name: "orders-prod" });
console.log(endpoint.ingestUrl); // the endpoint's signed ingest URL

for await (const endpoint of webhook.endpoints.list({ name: "prod" })) {
  console.log(endpoint.id);
}

// Or collect everything (careful with large result sets):
const failed = await webhook.deliveries.list({ status: ["failed"] }).collect();

// One page at a time (e.g. for your own UI):
const page = await webhook.endpoints.listPage({ limit: 50 });
console.log(page.items, page.nextCursor);

import { WebhookRateLimitError, WebhookNotFoundError } from "@webhook-co/sdk";

try {
  await webhook.endpoints.get(id);
} catch (err) {
  if (err instanceof WebhookNotFoundError) {
    // 404
  } else if (err instanceof WebhookRateLimitError) {
    console.log(`retry after ${err.retryAfterMs}ms`);
  } else {
    throw err;
  }
}

await webhook.events.replay({
  eventId: event.id,
  target: { kind: "destination", destinationId },
  idempotencyKey: crypto.randomUUID(),
});

const { ingestUrl } = await webhook.endpoints.revealIngestUrl(endpoint.id);

const trigger = await webhook.triggers.create({ endpointId: endpoint.id });

let cursor: string | null = null;
for (;;) {
  const page = await webhook.triggers.wait(trigger.id, { cursor });
  for (const event of page.events) handle(event);
  cursor = page.nextCursor; // feed straight back in
  if (page.caughtUp) await sleep(1000); // <- the caught-up signal
}

const usage = await webhook.usage.get(); // events counted, the cap, whether you are paused
await webhook.endpoints.update(id, { dedupConfig: null }); // null resets to the default
await webhook.events.delete(eventId); // redacts + purges ONE event; does not reduce metered usage

const webhook = new WebhookClient({
  apiKey,
  onAdvisory: (a) => log.warn(a.message), // fires at most once per client
  // silenceAdvisories: true,             // …or hear nothing at all
});

const webhook = new WebhookClient({
  apiKey,
  baseUrl: "https://api.webhook.co", // https-only (loopback http allowed for dev)
  maxRetries: 4, // default 2
  timeoutMs: 15_000, // default 30_000
});