POST /v1/webhooks/{id}/replay
POST /v1/webhooks/{id}/replay
| Scope | Idempotency-Key | Operation ID |
|---|---|---|
webhooks.manage | Required | replayWebhook |
Replay an endpoint's undelivered events within the retention window.
The endpoint's failed deliveries since since become due now. Events of its
subscriptions that it was never sent, because it was disabled or registered later, are
queued. since is clamped to the retention window. Events already delivered are not sent
again. A disabled endpoint must be re-registered first (VALIDATION_FAILED,
detail.reason: endpoint_disabled). Answers 202; the engine sends them. Idempotency-Key
required. Audited.
Request
Signed with your API credential: see Authentication.
| Parameter | In | Required | Description |
|---|---|---|---|
Idempotency-Key | header | Yes | One key per user intent, reused for every retry of that intent. See Idempotency. |
id | path | Yes | Pattern ^WHK-[0-9A-HJKMNP-TV-Z]{8}$. |
Body
| Field | Type | Required | Description |
|---|---|---|---|
since | string, date-time | No | |
event_types | array of string | No | One of: delivery.requested, delivery.assigned, rider.accepted, delivery.picked_up, delivery.on_the_way, delivery.arrived, delivery.delivered, delivery.cancelled, delivery.reassigned, delivery.failed, delivery.exception_raised, delivery.batched, delivery.unbatched, relay.requested, relay.claimed, relay.completed, relay.failed, payment.state_changed, partner.blocked, partner.reactivated, bulk.created, bulk.recipient_confirmed, bulk.quote_ready, bulk.confirmed, bulk.progress_updated, bulk.completed, bulk.cancelled, credential.revoked. |
Responses
202
Queued.
| Field | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | Pattern ^WHK-[0-9A-HJKMNP-TV-Z]{8}$. |
since | string, date-time | Yes | |
rearmed | integer | Yes | |
enqueued | integer | Yes |
400
Structural validation failed or an Idempotency-Key is missing.
The error envelope: code, message, detail, request_id.
401
Unknown, revoked or wrong-environment credential, bad signature, or expired session.
The error envelope: code, message, detail, request_id.
403
Tenant access denied (existence is not disclosed), insufficient scope, MFA/step-up required, partner blocked or module disabled.
The error envelope: code, message, detail, request_id.
409
State changed, race lost, or idempotency conflict. Refetch before deciding again.
The error envelope: code, message, detail, request_id.
429
Rate limit reached; honour Retry-After.
The error envelope: code, message, detail, request_id.
500
Unexpected failure. Only code and request_id are returned.
The error envelope: code, message, detail, request_id.