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
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/events/{id} | Retrieve an event |
GET | /v1/events | List events |
List Events
GET /v1/events
| Parameter | Type | Description |
|---|---|---|
type | string | Filter by event type |
limit | integer | Number of results (1–100) |
starting_after | string | Pagination cursor |
created[gte] | integer | Filter events created after this timestamp |
created[lte] | integer | Filter events created before this timestamp |
See Event Types for the full list of event types.