Webhook deliveries
Generated from Depllo's own code: every route in this area, what it takes and how to call it.
List webhook deliveries, newest first: status (pending, succeeded, failed), attempt count, next retry, the body sent and every attempt made (attemptLog).
GET /api/v1/webhook-deliveries
List webhook deliveries, newest first: status (pending, succeeded, failed), attempt
count, next retry, the body sent and every attempt made (attemptLog). Filter by
endpointId, status or type; page with limit (1-100, default 20) and
meta.cursor while meta.hasMore.
Query parameters
| Name |
Type |
Required |
Notes |
limit |
integer |
no |
default 20; min 1; max 100 |
cursor |
string |
no |
min length 1 |
endpointId |
string |
no |
min length 1 |
status |
pending or succeeded or failed |
no |
|
type |
string |
no |
min length 1 |
Example
curl -X GET "https://depllo.forjio.com/api/v1/webhook-deliveries" \
-H "Authorization: Bearer sk_live_<your API key>"
Get a webhook delivery, with every attempt made at it.
GET /api/v1/webhook-deliveries/{id}
Path parameters
| Name |
Type |
Required |
Notes |
id |
string |
yes |
|
Example
curl -X GET "https://depllo.forjio.com/api/v1/webhook-deliveries/:id" \
-H "Authorization: Bearer sk_live_<your API key>"
Retry a webhook delivery: one more attempt now at a failed delivery (or send a succeeded one again).
POST /api/v1/webhook-deliveries/{id}/retry
Retry a webhook delivery: one more attempt now at a failed delivery (or send a
succeeded one again). Answers 202 with the delivery pending; it goes out within
seconds — read it back with GET /webhook-deliveries/{id}. 409 ALREADY_QUEUED when it
is pending already, 409 ENDPOINT_DISABLED when its endpoint is off.
Path parameters
| Name |
Type |
Required |
Notes |
id |
string |
yes |
|
Example
curl -X POST "https://depllo.forjio.com/api/v1/webhook-deliveries/:id/retry" \
-H "Authorization: Bearer sk_live_<your API key>"