Skip to main content

Events

Events represent things that happened in your account. They are the payloads delivered to your webhook endpoints.

The Event object

{
"id": "evt_abc123",
"object": "event",
"type": "payment_intent.succeeded",
"created": 1708300800,
"data": {
"id": "pi_xyz789",
"object": "payment_intent",
"amount": 10000,
"currency": "xof",
"status": "succeeded"
}
}

Endpoints

MethodEndpointDescription
GET/v1/events/{id}Retrieve an event
GET/v1/eventsList events

List Events

GET /v1/events
ParameterTypeDescription
typestringFilter by event type
limitintegerNumber of results (1–100)
starting_afterstringPagination cursor
created[gte]integerFilter events created after this timestamp
created[lte]integerFilter events created before this timestamp

See Event Types for the full list of event types.