PApaycrest
Sender

List webhook deliveries

Changed on

Returns the authenticated sender's webhook delivery log, newest first. Use this to audit which events were delivered and to find failed or expired deliveries to replay. List items omit the large payload and responseBody fields; fetch a single delivery to see them.

get/sender/webhooks

Request

  • Base URL
    https://api.paycrest.io/v2
  • URL
    https://api.paycrest.io/v2/sender/webhooks
  • Auth
    API key in header API-Key

Query parameters

status'pending' | 'success' | 'failed' | 'expired'

Filter by delivery status.

eventstring

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

event_idstring uuid

Filter by the underlying event identifier.

order_idstring uuid

Filter to deliveries for a single payment order.

fromstring date-time

Only deliveries created at or after this timestamp.

tostring date-time

Only deliveries created at or before this timestamp.

pageinteger
pageSizeinteger

Response

List of webhook deliveries

statusstring
messagestring

Example response

{
  "data": {
    "deliveries": [
      {
        "statusCode": 200,
        "attemptNumber": 1
      }
    ]
  }
}

Changes

  • b2558cacb755Revision changes
    • breaking

      for the query request parameter event_id, the format changed from no format to uuid

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new payment_order.compliance_hold enum value to the /// response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property to the response with the status