List Events

Retrieve a paginated list of events for a given organisation, with optional sorting and filtering parameters

GET /events

List Events

cURL

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/events \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "items": [
      {
        "action": "<string>",
        "data": {},
        "delivery_status": "<string>",
        "display_id": "<string>",
        "event_id": 123,
        "id": "<string>",
        "timestamp": "<string>",
        "type": "<string>",
        "webhook_request": "<string>",
        "webhook_response": "<string>",
        "webhook_response_error": "<string>",
        "webhook_response_status": 123,
        "webhook_sent_at": "<string>",
        "webhook_url": "<string>"
      }
    ],
    "last_update": "2021-01-01T00:00:00.000Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

Authorizations

X-API-KEY · string · header · required

Query Parameters

document_id · string

Filter events related to a specific document/payment/invoice ID.

event_action · enum<string>

Filter by EventAction label.

Available options: Unknown, Created, Updated, Queued, Processed, Disabled, Enabled, Canceled, Refunded, Overdue, Delayed, Settled, LowBalanceDetected, VirtualAccountAlert

event_status · enum<string>

Filter by latest delivery outcome.

Available options: succeeded, failed

event_type · enum<string>

Filter by EventType label.

Available options: Unknown, Org, MerchantContract, Customer, Payment, Plan, Subscription, Invoice, Transaction, OfframpTransaction, CryptoTransaction, Account

limit · integer

Page size. Defaults to 100. Minimum 1, maximum 100.

Required range: 1 <= x <= 100

page · integer

Page number (1-based). Defaults to 1.

Required range: x >= 1

since · string<date-time>

Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at.

sort · enum<string>

Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc.

Available options: asc, desc

sort_by · enum<string>

Sort order field. Use delivered_at to order by delivery time; default is legacy (id/timestamp).

Available options: delivered_at

until · string<date-time>

Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at.

Response

200

application/json

OK

data · object

Paginated payload.

Show child attributes

error · boolean

True when the request failed.