APIWebhooks

Webhook Delivery Retry

Retry a delivery with a fresh set of attempts. Only a `failed` delivery on an `active` webhook can be retried.

POST
/webhooks/{webhook_id}/deliveries/{delivery_id}/retry

Retry a delivery with a fresh set of attempts. Only a failed delivery on an active webhook can be retried.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.

Required permission

manage_webhooks

Path Parameters

webhook_id*string
Formatuuid
delivery_id*string
Formatuuid

Response Body

The request has succeeded.

application/json
  1. response

One sent (or sending) message; id is the webhook-id header value.

id*uuid
Formatuuid
webhook_id*uuid
Formatuuid
status*WebhookDeliveryStatus

Delivery outcome for a single message.

Value in"pending""retrying""succeeded""failed"
event_count*integer

Number of audit events bundled into this delivery.

Formatint32
attempt_count*integer

How many times delivery has been attempted so far.

Formatint32
attempts*array<>

The individual attempts, oldest first.

next_retry_at?string

When the next automatic retry is scheduled; absent when no retry is pending.

Formatdate-time
retryable*boolean

Whether this delivery can be retried. False once it has succeeded, and for a delivery that never produced a body — there is nothing to re-send. The webhook must also be active, which this field does not cover.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X POST "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08/retry"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675",  "status": "pending",  "event_count": 0,  "attempt_count": 0,  "attempts": [    {      "at": "2019-08-24T14:15:22Z",      "status_code": 0,      "error": "string",      "duration_ms": 0,      "response_snippet": "string"    }  ],  "next_retry_at": "2019-08-24T14:15:22Z",  "retryable": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}