Skip to main content
GET
/
sender
/
webhooks
List webhook deliveries
curl --request GET \
  --url https://api.paycrest.io/v2/sender/webhooks \
  --header 'API-Key: <api-key>'
{
  "status": "<string>",
  "data": {
    "total": 123,
    "page": 123,
    "pageSize": 123,
    "deliveries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventId": "<string>",
        "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "httpStatusCode": 200,
        "attemptNumber": 1,
        "destinationUrl": "<string>",
        "signature": "<string>",
        "errorMessage": "<string>",
        "durationMs": 123,
        "nextRetryTime": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
API-Key
string
header
required

Query Parameters

​
status
enum<string>

Filter by delivery status.

Available options:
pending,
success,
failed,
expired
​
event
string

Filter by event name, e.g. payment_order.settled.

​
event_id
string

Filter by the underlying event identifier.

​
order_id
string<uuid>

Filter to deliveries for a single payment order.

​
from
string<date-time>

Only deliveries created at or after this timestamp.

​
to
string<date-time>

Only deliveries created at or before this timestamp.

​
page
integer
default:1
​
pageSize
integer
default:10

Response

List of webhook deliveries

​
status
string
​
data
object