Webhooks

List Endpoints

List the org's registered webhook endpoints.

Headers

• X-Organization-IDstringoptional

Create Endpoint

Register a webhook endpoint and mint a signing secret. The secret appears only in this response; use /rotate to replace it. Each event type must map to a registered OperationSpec with customer webhook visibility. Unknown types return 400 webhook_event_unknown; platform-internal types return 403 webhook_event_not_subscribable. The synthetic webhook.test event is always accepted.

Headers

• X-Organization-IDstringoptional

Request body

• urlstring (uri)required
• events_subscribedstring[]required
• descriptionstringoptional

Read Endpoint

Read a single endpoint's metadata.

Path parameters

• endpoint_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

Delete Endpoint

Delete an endpoint. Cascade clears its delivery audit.

Path parameters

• endpoint_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

List Deliveries

List recent deliveries for the endpoint, newest first. Exposes the dispatcher's audit: HTTP status, response preview and retry schedule.

Path parameters

• endpoint_idstring (uuid)required

Query parameters

• limitintegeroptional
• offsetintegeroptional

Headers

• X-Organization-IDstringoptional

Get Webhook Diagnostics

Composite delivery-health diagnostic for a single webhook endpoint. Counts cover the 500 most recent deliveries. Deviations are typed so the SDK and frontend can branch on them.

Path parameters

• endpoint_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

Rotate Endpoint

Rotate the signing secret. Returns the new secret once. Deliveries enqueued after rotation sign with the new secret; in-flight deliveries already in the dispatcher's batch may still sign with the old one. Receivers should accept both for a brief grace window.

Path parameters

• endpoint_idstring (uuid)required

Headers

• X-Organization-IDstringoptional

Test Endpoint

Fire a synthetic test event at the endpoint. Poll GET /v1/webhooks/{id}/deliveries for the outcome. Test events follow the same retry and DLQ semantics as production events.

Path parameters

• endpoint_idstring (uuid)required

Headers

• X-Organization-IDstringoptional