Documentation

Everything you need to ship your first event.

Install the SDK, send an event, verify a signature. Most teams are in production in an afternoon.

Install the SDK

One package, zero peer dependencies. Works in Node, Bun, Deno and edge runtimes.

Send an event

Call send() with an event name and payload. The response contains the event id and a delivery URL.

Verify the signature

Use the SDK helper or four lines of HMAC to confirm the request came from Hookline.

$npm install @hookline/sdk

1import { Hookline } from "@hookline/sdk"
2 
3const hooks = new Hookline({
4  apiKey: process.env.HOOKLINE_KEY,
5})
6 
7await hooks.send({
8  event: "invoice.paid",
9  endpoint: "ep_8f2k1",
10  payload: { invoiceId: "inv_1042", amount: 4900 },
11  // signed, retried, replayable
12})

Browse

Pick up where you need to.

Sending events

Event names, payload limits, idempotency keys and ordered delivery.

Read

Signing and verification

HMAC-SHA256 headers, timestamps, replay protection and secret rotation.

Read

Retries and backoff

Default schedules, Retry-After handling, circuit breakers and dead letters.

Read

Replay

Replay by event, endpoint or time range from the dashboard, CLI or API.

Read

CLI and dev server

Install the CLI, tunnel to localhost and replay real events while you build.

Read

API reference

REST endpoints, SDK method signatures and webhook payload schemas.

Read

Stuck on something?

Engineers answer in Discord within the hour, by email within a business day.

Join Discord

Contact support

Buy this template

$49