Developers

Delete a webhook endpoint

DELETE/webhooks/{webhook_id}

Deletes a webhook endpoint so that it no longer receives events.

Deliveries that are still pending are canceled. Deliveries that have already completed are not affected.

AuthorizationBearer <token>

Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

webhook_id*string

Public ID of the webhook, prefixed with whk_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/webhooks/string"
Empty

Update a webhook endpoint PATCH

Updates the URL, subscribed event types, resource filters, event filters, description, payload detail level, or status of a webhook endpoint. Changing `status` requires the `webhooks.activate` permission in addition to `webhooks.update`. A new URL is subject to the same destination restrictions as the create operation. Changing `payload_detail` to `full`, or changing the event types of an endpoint whose `payload_detail` is `full`, requires the personal data permissions described in that field. Without them, the request fails with `403` and the error code `personal_data_permission_required`, and nothing is changed. Deliveries already queued keep the `expanded` object built when they were created, and send it only while the endpoint still accepts that level: after lowering the level, a retry is sent without `expanded`. Setting `status` to `active` on an endpoint that the platform deactivated after repeated delivery failures reactivates it: its failure count is reset, and deliveries from the last 48 hours that ended as `dead` or were canceled by the deactivation go back to the queue. Setting `status` to `inactive` on such an endpoint does not change it. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting changes made since the endpoint was retrieved. If the header is omitted, the update is applied to the current revision.

List deliveries for a webhook endpoint GET

Returns the deliveries of a webhook endpoint, paginated by cursor. The collection can be filtered by status, event ID, event type, and creation time. Deliveries are retained for at least 60 days after they are created, together with their attempts. A delivery that has not reached a final status (`pending` or `in_progress`) is never removed.