API reference / Webhook endpoints
Webhook endpoints
GET /v1/webhooks
List Webhooks
Responses
- 200
array of WebhookOut - 4xx 5xx
application/problem+json; see the error reference.
POST /v1/webhooks
Create Webhook
Request body (application/json, required)
| Member | Type | Notes |
|---|---|---|
events | array of string | |
url required | string (max length 2000) |
Responses
- 201 WebhookCreated
- 4xx 5xx
application/problem+json; see the error reference.
PATCH /v1/webhooks/{webhook_id}
Patch Webhook
D58(a): edit url/events, and re-enable (`active: true`).
Path
webhook_idstring (uuid)
Request body (application/json, required)
| Member | Type | Notes |
|---|---|---|
active | boolean | null | |
events | array of string | null | |
url | string (max length 2000) | null |
Responses
- 200 WebhookOut
- 4xx 5xx
application/problem+json; see the error reference.
DELETE /v1/webhooks/{webhook_id}
Delete Webhook
Path
webhook_idstring (uuid)
Responses
- 204 no body
- 4xx 5xx
application/problem+json; see the error reference.
GET /v1/webhooks/{webhook_id}/deliveries
List Deliveries
Path
webhook_idstring (uuid)
Query
-
statusstring | null -
limitinteger (>= 1, <= 200) default50
Responses
- 200
array of DeliveryOut - 4xx 5xx
application/problem+json; see the error reference.
POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver
Redeliver
Path
webhook_idstring (uuid)delivery_idinteger
Responses
- 202 RedeliverOut
- 4xx 5xx
application/problem+json; see the error reference.
POST /v1/webhooks/{webhook_id}/disable
Disable Webhook
Path
webhook_idstring (uuid)
Responses
- 204 no body
- 4xx 5xx
application/problem+json; see the error reference.
POST /v1/webhooks/{webhook_id}/ping
Ping Webhook
D58(a): queue one delivery of type `ping`, signed like any other. `ping` is not subscribable (EVENT_TYPES is unchanged); the deliverer sends every queued row regardless of the endpoint's event filter.
Path
webhook_idstring (uuid)
Responses
- 202 PingOut
- 4xx 5xx
application/problem+json; see the error reference.
POST /v1/webhooks/{webhook_id}/rotate-secret
Rotate Secret
D58(a): a new secret, shown once; the previous one keeps co-signing deliveries for ROTATION_GRACE (`v1=<new>,v1=<old>` in the header) so a handler can be switched without a signature outage. A second rotation inside the window retires the older secret immediately: at most two secrets are ever live.
Path
webhook_idstring (uuid)
Responses
- 200 WebhookCreated
- 4xx 5xx
application/problem+json; see the error reference.