Developers
Webhooks13

Replay webhook events

POST/webhooks/{webhook_id}/replays

Resends, in bulk, events that were already delivered to this webhook endpoint. The selection can be narrowed by event_ids, by an occurred_after/occurred_before time range, and by event_types. Only events that occurred before the request was received and are still retained are eligible.

The replay is processed asynchronously as an operation with one item per event. Use the Location header to track its progress and per-event results.

A replay adds new attempts to the existing deliveries; it never creates new deliveries. The request is rejected if no eligible events match the selection.

Authorization

AuthorizationBearer <token>

Autonomous mode: 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._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. 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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhooks/string/replays" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "attempt": {      "number": 0,      "status": "running"    },    "cancellation_requested": true,    "created_at": "2019-08-24T14:15:22Z",    "error": {      "code": "worker_error",      "field": "string",      "message": "string",      "reason": "string",      "resource_id": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "finished_at": "2019-08-24T14:15:22Z",    "id": "string",    "items_url": "string",    "object": "operation",    "progress": {      "done": 0,      "failed": 0,      "total": 0    },    "result_url": "string",    "started_at": "2019-08-24T14:15:22Z",    "status": "queued",    "type": "string"  }}

Retrieve a delivery attempt GET

Retrieves a single attempt of a webhook delivery. The response excerpt captured from the receiving endpoint is masked.

Rotate a webhook signing secret POST

Generates a new signing secret for the webhook endpoint. The previous secret remains valid for `overlap_hours` (24 hours by default, up to 72). During this period, each delivery carries one signature per active secret. The new secret is returned only once. Retrying the request with the same `Idempotency-Key` does not return the secret again.