webhook-deliveries
Stable. Describes behaviour that is built and covered by tests in this repository.
GET /v1/webhook-deliveries #
Deliveries, newest first, with how each attempt went
Parameters
| Name | In | Type | Description |
|---|---|---|---|
endpoint_id | query | string · uuid | |
state | query | pending | delivered | failed | |
page_size | query | integer | |
page_token | query | string |
Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | ListWebhookDeliveriesResponse |
400 | Error envelope | Error |
Example response
{
"deliveries": [
{
"id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"event_id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"event_type": "string",
"endpoint_id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"state": "WEBHOOK_DELIVERY_STATE_PENDING",
"attempts": 1,
"next_attempt_time": "2026-11-03T10:15:00Z",
"last_status": 1,
"last_error": "string",
"create_time": "2026-11-03T10:15:00Z",
"delivered_time": "2026-11-03T10:15:00Z"
}
],
"next_page_token": "string"
}curl
curl -X GET https://YOUR-API-ADDRESS/v1/webhook-deliveries \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"POST /v1/webhook-deliveries/{id}/redeliver #
Send a delivery again from the start, whatever became of it
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id required | path | string · uuid |
Responses
| Status | Meaning | Body |
|---|---|---|
202 | Queued | WebhookDelivery |
404 | Error envelope | Error |
Example response
{
"id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"event_id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"event_type": "string",
"endpoint_id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"state": "WEBHOOK_DELIVERY_STATE_PENDING",
"attempts": 1,
"next_attempt_time": "2026-11-03T10:15:00Z",
"last_status": 1,
"last_error": "string",
"create_time": "2026-11-03T10:15:00Z",
"delivered_time": "2026-11-03T10:15:00Z"
}curl
curl -X POST https://YOUR-API-ADDRESS/v1/webhook-deliveries/<id>/redeliver \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"Models
Error
| Field | Type | Description |
|---|---|---|
error required | object |
ListWebhookDeliveriesResponse
| Field | Type | Description |
|---|---|---|
deliveries required | array of WebhookDelivery | |
next_page_token required | string |
WebhookDelivery
| Field | Type | Description |
|---|---|---|
id required | string · uuid | |
event_id required | string · uuid | The id inside the delivered body and the Payrudder-Event-Id header |
event_type required | string | A WebhookEventType, or ping for the test event |
endpoint_id required | string · uuid | |
state required | WEBHOOK_DELIVERY_STATE_PENDING | WEBHOOK_DELIVERY_STATE_DELIVERED | WEBHOOK_DELIVERY_STATE_FAILED | |
attempts required | integer | |
next_attempt_time required | string · date-time | Set while the delivery is pending |
last_status required | integer | HTTP status of the last attempt; 0 when no attempt got an answer |
last_error required | string | |
create_time required | string · date-time | |
delivered_time required | string · date-time | Set once the endpoint answered 2xx |