Skip to main content
1

Get an API key

Create a whk_ API key in your dashboard and export it:
export WEBHOOK_API_KEY=whk_your_key_here
2

Install an SDK

npm install @webhook-co/sdk
3

Create an endpoint

Each endpoint has a signed ingest URL that’s returned once at creation — capture it now.
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);
4

List the events it captures

Point a provider at the ingest URL, then iterate the captured events. List methods auto-paginate.
for await (const event of webhook.events.list(endpoint.id)) {
  console.log(event.id, event.provider, event.verificationState);
}

​
Next

Browse the full API reference (generated from the live OpenAPI spec, with an interactive playground), or dive into your language’s SDK guide for retries, errors, replay, and more.