POST /v3/callbacks/endpoints/{id}/replay
Queues again the failed and dropped deliveries of one endpoint created in a window (202 {replayed, truncated, last_created_at}): oldest first, at most 10,000 a call (truncated; continue with from = last_created_at). The window is at most 30 days. Deliveries that were billed, test deliveries and endpoint verifications are never requeued; held and pending ones are left to the deliverer. 409 replay_running while a replay of this endpoint is less than 60 seconds old (Retry-After). 403 plan_required, 409 endpoint_unverified or endpoint_disabled as for a retry; a deleted endpoint is 404. 503 callbacks_unavailable while this server has no callback key file or its database lacks the callback tables.
API key: required. See Authentication.
Group: Webhooks (API: callbacks)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
id | path | string | yes | The endpoint's id (cbe_ and 24 hex digits). |
Request body
A CallbackReplayRequest object, as JSON.
| Field | Type | Required | Description |
|---|---|---|---|
from | string | yes | Start of the window of created_at, inclusive: YYYY-MM-DDTHH:MM:SSZ, or YYYY-MM-DD for midnight UTC. |
states | array of string | no | Default both. |
to | string | no | End of the window, exclusive, same forms; default now. The window is at most 30 days. |
types | array of string | no | Only deliveries of these event types; default every type. |
Responses
| Status | Body | Description |
|---|---|---|
202 | CallbackReplayResult (application/json) | OK |
400 | Problem (application/problem+json) | Invalid or unknown parameter, or a body that is not one JSON document (code invalid_body). |
401 | Problem (application/problem+json) | Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728). |
403 | Problem (application/problem+json) | The credential's scope does not cover this route (code forbidden), or the organization's plan has no webhook deliveries (code plan_required). |
404 | Problem (application/problem+json) | Not found. |
409 | Problem (application/problem+json) | invalid_state: the delivery is not failed, or it was billed, or it is a test delivery or an endpoint verification; limit_reached (kind manual_retries, limit, used): the delivery was retried by hand twice already; replay_running (Retry-After): a replay of this endpoint started less than 60 seconds ago; endpoint_unverified or endpoint_disabled: the endpoint cannot be sent to now. |
415 | Problem (application/problem+json) | The body is not sent as Content-Type: application/json (code unsupported_media_type). |
503 | Problem (application/problem+json) | Callbacks are not available: this server has no callback key file or its database lacks the callback tables (code callbacks_unavailable); too many callback URLs are being checked at once (code db_unavailable, reason resolver_busy, Retry-After 1); or the database is unavailable (code db_unavailable). |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 202 carries a CallbackReplayResult object.
| Field | Type | Required | Description |
|---|---|---|---|
last_created_at | date-time (RFC 3339, UTC) | null | yes | When truncated: the created_at (whole seconds) of the last delivery requeued; replay again with the same to, states and types and from set to it. |
replayed | integer | yes | Deliveries requeued. |
truncated | boolean | yes | true when more than 10,000 deliveries matched; the oldest 10,000 were requeued. |
Example request
curl -sS -X POST -H "Authorization: Bearer $SECBLAST_API_KEY" \
-H "Content-Type: application/json" -d @body.json \
'https://api.secblast.com/v3/callbacks/endpoints/cbe_0123456789abcdef01234567/replay'More in Webhooks (API: callbacks)
Previous: DELETE /v3/callbacks/endpoints/{id} · Next: POST /v3/callbacks/endpoints/{id}/rotate-secret
Markdown version: /docs/reference/post-callbacks-endpoints-id-replay.md