logo
Merchant Invoices Webhooks APIGet webhook events history for an invoice

Get webhook events history for an invoice

Returns the full webhook delivery history for a specific invoice — every event that was generated (e.g. invoice.success, invoice.fail, invoice.expired, invoice.adjusted) along with all delivery attempts the worker has performed (and any manual resends triggered via POST /invoices/{invoice_ref}/webhooks/resend).

invoice_ref accepts either:

  • our internal order_id (UUID assigned by the platform), or
  • the merchant's own external_id supplied at invoice creation.

Lookup is scoped to the authenticated merchant. Events are ordered by creation time, newest first; attempts within an event are ordered by try_number ascending. Returns events: [] (with events_count=0) if no webhooks have been generated for this invoice yet — this is a valid 200 response, not a 404.

curl -X GET "https://api.example.com/v1/api/v1/invoices/example_string/webhooks" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "successful": true,
  "invoice_id": "example_string",
  "external_id": "example_string",
  "events_count": 10,
  "events": [
    {
      "event_id": 123,
      "event_type": "example_string",
      "status": "example_string",
      "callback_url": "example_string",
      "auto_attempts": 42,
      "manual_attempts": 42,
      "total_attempts": 42,
      "next_retry_at": "2024-12-25T10:00:00Z",
      "locked_at": "2024-12-25T10:00:00Z",
      "locked_by": "example_string",
      "request_payload": "null",
      "created_at": "2024-12-25T10:00:00Z",
      "updated_at": "2024-12-25T10:00:00Z",
      "attempts": [
        {
          "try_number": 42,
          "trigger": "example_string",
          "attempt_status": "example_string",
          "http_status": 42,
          "response_headers": {},
          "response_body": "example_string",
          "error_message": "example_string",
          "duration_ms": 42,
          "created_at": "2024-12-25T10:00:00Z"
        }
      ]
    }
  ]
}
GET
/api/v1/invoices/{invoice_ref}/webhooks
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Merchant API Key.

Merchant API Key.
path
invoice_refstring
Required

Invoice identifier — either our order_id (UUID) or the merchant's external_id

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Merchant API Key.

Path Parameters

invoice_refstring
Required

Invoice identifier — either our order_id (UUID) or the merchant's external_id

Responses

successfulboolean
invoice_idstring
Required

Internal invoice order_id (UUID)

external_idstring

Merchant's external_id for this invoice

events_countinteger
Required

Total number of webhook events generated for this invoice

eventsarray

Webhook events for this invoice, newest first