v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Webhooks

Retrieve webhook entries

This endpoint can help you debug pending/failed webhook entries. Required scope: webhooks:read

get/api/v1/webhooks/entries

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

status'pending' | 'completed' | 'failed' nullable

Filter to retrieve entries by status

Example:failed

Response

List of webhook entries for your consumer in the past 24 hours

Example response

{
  "data": [
    {
      "id": 1,
      "consumerId": 1,
      "operatorId": 1,
      "payload": {
        "entityId": "42",
        "eventTime": "2024-10-22T16:56:45.999Z",
        "payload": [
          {
            "id": "42",
            "amount": 1000
          }
        ]
      },
      "error": {
        "errorCode": "502 Bad Gateway",
        "errorMessage": "<html>\n  <head>\n    <title>Bad Gateway<\\title>\n  </head>\n  <body>\n    <p>The server is unreachable at this time.</p>\n  </body>\n</html>"
      },
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z"
    }
  ]
}