The event object
Event types
Events require
events:read scope.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Log of all events delivered to your webhook endpoints
| Field | Type | Description |
|---|---|---|
id | uuid | Unique identifier |
object | string | Always "event" |
type | string | Event type, e.g. session.paid |
livemode | boolean | true for live transactions, false for test |
data | object | The resource that triggered the event (e.g. a CheckoutSession) |
createdAt | datetime |
| Type | Triggered when |
|---|---|
session.paid | Payment confirmed with required confirmations |
session.paid_late | Payment confirmed after expiry, within the grace window |
session.expired | Session timed out with no payment |
session.detected | Transfer first detected on-chain |
session.underpaid | Transfer detected but amount is insufficient |
session.overpaid | Transfer detected but amount exceeds what was expected |
events:read scope.