Sends one webhook delivery to your endpoint again.
POST
/api/notifications/events/{id}/replay
deprecated
Requires: Notifications.Events.Replay, merchant scope.
This is the other half of recovering from an outage: list what you missed, then ask for the ones that did not land to be sent again. The platform resets the delivery and attempts it on its own delivery path, so the payload, the signature and the headers are the ones your endpoint would have received. <b>What replay can recover, and what it cannot.</b> Only a delivery this platform raised and that ended `Failed`, `DeadLettered` or `Skipped`. An event that never became a delivery cannot be replayed, because there is nothing to send; neither can one that already succeeded. <b>It answers with what happened, so it runs while you wait.</b> One attempt is bounded by the platform's own attempt deadline of two minutes; in practice your endpoint's own timeout ends it far sooner. <b>Three separate limits apply, and none of them needs an idempotency key.</b> Your API key's request limit bounds how often you may ask. A per-endpoint replay budget bounds how much the platform will send to one address in a window, and a request over it is refused without touching the delivery. And asking twice for a delivery that has since succeeded is refused, because a delivered replay is no longer replayable.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id
required |
path | string (uuid) | The delivery to replay. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 The delivery was reset and attempted. The outcome says whether your endpoint accepted it, refused it, or was never contacted.
Body: WebhookEventReplayResultDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
id
required |
string (uuid) | The delivery that was replayed. |
outcome
required |
all of WebhookEventReplayOutcome | What the platform did about it. |
This response has no documented body fields.
403 The credential resolves no single merchant.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
404 No such delivery for this merchant. A mistyped id, another merchant's id and a delivery on a channel this surface does not publish are deliberately indistinguishable.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
409 The delivery is not replayable, or its destination endpoint is currently suppressed. Nothing was changed either way.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
429 This endpoint's replay budget for the current window is spent. Nothing was changed; try again after the window rolls over.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.