v13

latestOpenAPI 3.0.1raw.githubusercontent.com2025-04-1011714.5 KB
Webhooks

Get webhook messages by webhook external ID

get/v1/webhook/{webhookExternalId}/message

Path parameters

webhookExternalIdstring required

Query parameters

pageinteger
status'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'WILL_NOT_SEND'

If supplied, will only list messages with this delivery status

resource_idstring

The external ID of the resource (e.g. the payment) to get messages for

Response

OK

countinteger

The number of results in the current page

pageinteger

The page of results

totalinteger

The total number of results

Example response

{
  "count": 10,
  "page": 1,
  "results": [
    {
      "event_type": "card_payment_started",
      "external_id": "s0wjen129ejalk21nfjkdknf1jejklh",
      "latest_attempt": {
        "response_time": 23,
        "result": "200 OK",
        "status": "SUCCESSFUL",
        "status_code": 200
      },
      "resource": {
        "path": "description",
        "op": "replace",
        "value": "new description"
      },
      "resource_id": "payment-external-id-123",
      "resource_type": "payment"
    }
  ],
  "total": 100
}