Skip to content

Deliveries API

Base path: /api/deliveries

GET /api/deliveries

Returns all deliveries, most recent first.

GET /api/deliveries/{id}

Returns a single delivery with its payload, headers, status, and transformed data (if any).

{
"id": "a1b2c3d4-...",
"source_id": "...",
"idempotency_key": "...",
"headers": {"Content-Type": "application/json"},
"payload": {"event": "push", "data": {}},
"status": "completed",
"received_at": "2025-01-15T10:30:00Z",
"transformed_payload": null,
"transformed_headers": null
}
StatusDescription
pendingQueued, waiting for worker pickup
processingWorker is dispatching to actions
completedAll actions succeeded or were skipped
failedAt least one action exhausted all retries
recordedStored in record mode, not dispatched
GET /api/deliveries/{id}/attempts

Returns all dispatch attempts for a delivery, across all actions.

[
{
"id": "...",
"delivery_id": "...",
"action_id": "...",
"attempt_number": 1,
"status": "success",
"response_status": 200,
"response_body": "{\"ok\":true}",
"error_message": null,
"next_retry_at": null,
"created_at": "2025-01-15T10:30:01Z"
}
]