Skip to main content
GET
/
api
/
canary
/
events
Retrieves a log of all API events for debugging and logging.

​
Query Parameters

​
type
string
Filter by event type (e.g., “checkout.session.completed”, “payment.succeeded”)
​
startDate
string
Filter events from this date (ISO 8601 format)
​
endDate
string
Filter events until this date (ISO 8601 format)
​
offset
number
Number of events to skip (default: 0)
​
limit
number
Maximum number of events to return (default: 50)

​
Response

​
Success
​
data
array
Array of events
​
pagination
object
Pagination information

​
Example Response

{
  "data": [
    {
      "id": "event_001",
      "merchantId": "merchant_456",
      "type": "checkout.session.completed",
      "data": {
        "sessionId": "checkout_sess_123",
        "amount": 10000,
        "currency": "ZAR"
      },
      "relatedEntityId": "checkout_sess_123",
      "relatedEntityType": "CheckoutSession",
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 500,
    "hasMore": true
  }
}

​
Common Event Types

checkout.session.completed

Fired when a checkout session is completed successfully

payment.succeeded

Fired when a payment is processed successfully

payment.failed

Fired when a payment fails

customer.created

Fired when a new customer is created

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.