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.

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

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

curl -X POST "https://example.com/webhooks/string/replays" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "attempt": {      "number": 0,      "status": "running"    },    "cancellation_requested": true,    "created_at": "2019-08-24T14:15:22Z",    "error": {},    "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"  }}