API reference
List deliveries
Delivery attempts for one endpoint.
GET
/webhooks/:id/deliveriesDelivery attempts for one endpoint, newest first. Replay one with POST /webhooks/:id/deliveries/:deliveryId/replay.
- Permission
- read:webhooks
- Auth
- api-key
- Idempotent
- No
- Language
- Node.js
| Field | In | Type | Required | Description |
|---|---|---|---|---|
| status | query | string | No | succeeded, failed (retries exhausted) or pending. |
| eventId | query | string | No | Only deliveries of this event. |
| limit | query | integer | No · 50 | 1–100. |
| cursor | query | string | No | nextCursor from the previous page. |
const response = await fetch(`${process.env.BOSPAY_API_BASE}/webhooks/we_example/deliveries?status=failed&limit=20`, {
method: "GET",
headers: {
"Content-Type": "application/json",
"BOSPay-Version": "2026-09-23",
"X-API-Key": process.env.BOSPAY_API_KEY,
}
});
if (!response.ok) {
throw new Error(`BOSPay request failed: ${response.status}`);
}
const data = await response.json();Success
200
{
"object": "list",
"data": [
{
"id": "whd_example",
"object": "webhook_delivery",
"eventId": "evt_7Qx2mK9pL4sT8vW1yZ3aB6cD",
"eventType": "invoice.paid",
"status": "failed",
"statusCode": 500,
"attempts": 9
}
],
"hasMore": false,
"nextCursor": null
}Validation error
400
{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "A valid fiatAmount is required.",
"field": "fiatAmount",
"requestId": "req_3f0c9a1b2c4d5e6f7a8b9c0d"
}
}