Webhooks

Delete a webhook

Delete a webhook by id; deliveries to it stop immediately and any in-flight retries are abandoned. An unknown, already-deleted, or cross-tenant id returns not-found.

DELETE
/webhooks/{webhook_id}

Delete a webhook by id; deliveries to it stop immediately and any in-flight retries are abandoned. An unknown, already-deleted, or cross-tenant id returns not-found.

Authorization

x-api-key<token>

The per-tenant API key. Sent as the x-api-key request header. The key is tenant-scoped.

In: header

Path Parameters

webhook_id*string

The webhook's opaque id (e.g. wh_…).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/webhooks/string"
{  "webhook_id": "string",  "deleted": true}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}

Register a webhook POST

Register a webhook endpoint. `url` must be HTTPS and `event_types` must list at least one event type; `inbox_ids` (max 10) optionally scopes the endpoint to specific inboxes (omit for all of the tenant's inboxes). Supply a `client_id` for idempotency — repeating a create with the same `client_id` returns the existing webhook (`200`). The response includes the endpoint's **signing secret** (`whsec_…`), returned **only** here — store it now to verify deliveries.

Get a webhook GET

Fetch a single webhook by id. An unknown id and an id belonging to another tenant both return the same not-found error — existence is never leaked. The signing secret is not included (shown only at creation).