Sign in
latestOpenAPI 3.1.02026-08-213914255.9 MB

715c4defcbbf

Webhooks

Replay Delivery

Re-sends the exact payload of a past delivery to the webhook's current URL and returns the delivery result. By default the replay keeps the original webhook-id, so consumers that deduplicate on it can drop events they already processed. Pass regenerate_id to re-send under a freshly generated webhook-id instead, so a deduplicating consumer processes the replay as a new message. Only available for enabled webhooks on API version v1; deliveries are retained for 30 days.

post/webhooks/{id}/deliveries/{delivery_id}/replay

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

regenerate_idboolean

Re-send the delivery under a freshly generated webhook-id (in both the envelope and the signed headers) instead of the original one. Defaults to false. Use this when your endpoint deduplicates on webhook-id and you want it to process the replay as a new message.

Example request

{
  "regenerate_id": true
}

Response

delivery replayed

bodystring required

The body your endpoint returned for the replayed request, as raw text. Empty when the endpoint could not be reached.

statusinteger required

The HTTP response code your endpoint returned for the replayed request, or 0 when it could not be reached (timeout, DNS, or connection failure).

successboolean required

Whether your endpoint acknowledged the replay with a 2xx response.

Example response

{
  "body": "OK",
  "status": 200,
  "success": true
}