Miracle Docs
Webhooks

List webhook delivery records

Returns delivery records for webhook endpoints owned by the caller. Merchant callers see only records for their own endpoints. Filters: endpoint_id, event_type, status, created_after, created_before. Cursor-based pagination via cursor + limit (default 20, max 100).

GET
/v1/webhooks/deliveries
AuthorizationBearer <token>

In: header

Query Parameters

endpoint_id?string

Filter by a specific webhook endpoint. For merchant callers, ownership of the endpoint is verified.

Formatuuid
event_type?string

Filter by event type string (e.g. "payment.succeeded").

status?string

Filter by delivery status: pending, delivered, failed, or retrying.

Value in"pending" | "delivered" | "failed" | "retrying"
created_after?string

Return only records created at or after this timestamp (ISO 8601 UTC).

Formatdate-time
created_before?string

Return only records created at or before this timestamp (ISO 8601 UTC).

Formatdate-time
cursor?string

Pagination cursor returned from a previous list response.

Formatuuid
limit?integer

Page size. Default 20, max 100.

Range1 <= value <= 100

Response Body

application/json

curl -X GET "https://<api-host>/v1/webhooks/deliveries"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "livemode": true,
      "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
      "eventType": "string",
      "eventPayload": {
        "property1": null,
        "property2": null
      },
      "status": "pending",
      "attempts": [
        {
          "attemptNumber": 0,
          "requestedAt": "string",
          "responseStatus": 0,
          "responseBody": "string",
          "durationMs": 0,
          "error": "string"
        }
      ],
      "attemptCount": 0,
      "maxAttempts": 0,
      "nextRetryAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "prevCursor": "string",
    "hasMore": true,
    "totalCount": 0
  }
}
Empty
Empty

On this page