webhookEndpoints
Settings module · 5 operations
List webhook endpoint rows
GET/webhook-endpoints
A webhook endpoint. Deliveries are signed with HMAC-SHA256 and retried for 72 hours. Returns a cursor page of webhook endpoint rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a webhook endpoint
POST/webhook-endpoints
Creates an endpoint subscribed to the given event types through `app.create_webhook_endpoint`. The signing secret is returned once. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Get a webhook endpoint
GET/webhook-endpoints/{id}
A webhook endpoint. Deliveries are signed with HMAC-SHA256 and retried for 72 hours. Returns one webhook endpoint with its `ETag`. A webhook endpoint the caller may not see returns 404.
Update a webhook endpoint
PATCH/webhook-endpoints/{id}
A webhook endpoint. Deliveries are signed with HMAC-SHA256 and retried for 72 hours. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
Delete a webhook endpoint
DELETE/webhook-endpoints/{id}
A webhook endpoint. Deliveries are signed with HMAC-SHA256 and retried for 72 hours. Soft-deletes the webhook endpoint: it moves to Trash and can be restored for its table's retention period.