POST /v3/callbacks/deliveries/{id}/retry
Queues one more attempt of a failed delivery now (202, the delivery): it becomes pending and its attempts are not reset. At most twice per delivery (409 limit_reached). Only a failed delivery that was never billed: any other state, a test delivery and an endpoint verification are 409 invalid_state. 403 plan_required for a plan without deliveries; 409 endpoint_unverified or endpoint_disabled while the endpoint cannot be sent to. The body is optional and has no members. 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 delivery's id (dlv_ and 24 hex digits). |
Request body
A CallbackRetryRequest object, as JSON.
Responses
| Status | Body | Description |
|---|---|---|
202 | CallbackDelivery (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 CallbackDelivery object.
| Field | Type | Required | Description |
|---|---|---|---|
accession | string | null | yes | The filing's accession number, for filing events. |
attempt_count | integer | yes | Attempts made so far; a manual retry or a replay continues the count. |
billed_bytes | integer | yes | The payload bytes billed: the payload size once the endpoint answered 2xx, else 0. Failed attempts, test events and endpoint verification are not billed. |
created_at | date-time (RFC 3339, UTC) | yes | |
delivered_at | date-time (RFC 3339, UTC) | null | yes | |
endpoint_id | string | yes | cbe_ and 24 hex digits. |
held_reason | string | null | yes | Only while state is held. One of: quota_exceeded, plan_required, endpoint_disabled, endpoint_unverified, digest, null. |
id | string | yes | dlv_ and 24 hex digits. |
last_attempt_at | date-time (RFC 3339, UTC) | null | yes | When the newest attempt was made; null before the first. |
last_error | string | null | yes | Why the last attempt failed (an error class such as timeout, or gone, quota_exceeded, plan_required, hold_expired, endpoint_inactive, superseded: a verification challenge replaced by a newer one before it was sent). |
last_status | integer | null | yes | The HTTP status of the last attempt that got one. |
next_attempt_at | date-time (RFC 3339, UTC) | null | yes | When the next attempt is due; only while state is pending. |
state | string | yes | pending: waiting for its next attempt. held: waiting for a condition (held_reason). delivering: an attempt is in flight. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint answered 410, or a hold ran out (last_error says which). dropped: the endpoint was inactive or the hold on an unverified or disabled endpoint ran out, or (a verification) a newer challenge replaced it. One of: pending, held, delivering, delivered, failed, dropped. |
subscription_id | string | null | yes | sub_ and 24 hex digits; null for an event that belongs to no subscription. |
type | string | yes | The event type, for example filing.new. |
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/deliveries/dlv_0123456789abcdef01234567/retry'More in Webhooks (API: callbacks)
Previous: GET /v3/callbacks/deliveries/{id} · Next: GET /v3/callbacks/endpoints
Markdown version: /docs/reference/post-callbacks-deliveries-id-retry.md