Sign in
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
}

Changes

Changed in 4 of the 13 revisions of this API.13

  • e7d174740a841See the full diff
    • ○

      added the optional property total to the response with the 200 status

      response-optional-property-added

  • f583a561523b1See the full diff
    • ○

      added the new optional query request parameter resource_id

      new-optional-request-parameter

  • d695db3a1eea1See the full diff
    • ●

      removed the optional property total from the response with the 200 status

      response-optional-property-removed

  • a8ce27cb4fbb1See the full diff
    • ○

      added the optional property results/items/last_delivery_status to the response with the 200 status

      response-optional-property-added