Skip to navigation

Retry one delivery

Re-delivers a single event to this subscription only. The route picks one of three strategies, reported in the path field of the response:

  • hookdeck_replay — replays the original request, restricted to this subscription’s connection/destination. Answers 200.
  • facade_reemit — re-dispatches from the persisted envelope. Answers 202, since completion is asynchronous.
  • hookdeck_replay_legacy — for old deliveries with neither a request id nor an envelope, looks the event up in the delivery history. Answers 200.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscriptionIdstringRequired
Webhook subscription identifier.
deliveryIdstringRequired

Delivery identifier. May contain slashes (e.g. del_qrcode/cash-in:...).

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Response

Replay accepted (hookdeck_replay or hookdeck_replay_legacy).

deliveryIdstring
pathenum
Which strategy handled the retry.
Allowed values:
hookdeckRequestIdstringOptional

Only for hookdeck_replay.

hookdeckEventIdslist of stringsOptional
Only when the retry replayed an existing delivery.
replayedintegerOptional

Number of events replayed (hookdeck_replay).

workflowIdstringOptional

Only for facade_reemit.

runIdstringOptional

Only for facade_reemit.

replayDeliveryIdstringOptional

Internal id of the replay delivery (facade_reemit).

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
410
Gone Error
500
Internal Server Error
502
Bad Gateway Error