Events

Events are immutable account-scoped records of resource transitions. Listing events is useful for support, replay investigation and reconciliation, but it is not a real-time polling contract. Use signed webhooks for asynchronous delivery and retrieve an Event when you need to inspect its canonical stored payload.

An Event is the business fact (evt_...). A Webhook Event is a delivery attempt for that fact to a specific endpoint. Use /api/v1/events to inspect the immutable journal; use the Portal delivery inspector or paybytoken.webhookEvents in the Node SDK to inspect and retry failed deliveries.

API Endpoints

Get Event: Retrieves the details of a specific event by its ID.
List Events: Returns an offset-paginated list of account events.

API Endpoint Reference

Method	Endpoint	Description
GET	`/api/v1/events/:id`	Retrieves the details of a specific event.
GET	`/api/v1/events`	Lists account events in newest-first order.

Attributes

Attribute	Type	Description
`id`	string	Unique identifier for the event (e.g., `evt_123456`).
`account_id`	string	ID of the associated account (e.g., `acct_1`).
`resource_type`	string	Type of the associated resource (e.g., `payment_intent`).
`resource_id`	string	ID of the associated resource (e.g., `pay_123`).
`type`	string	Canonical event type (for example, `payment_intent.succeeded`).
`api_version`	string	Optional API version used for the event.
`livemode`	boolean	Indicates if the event occurred in live mode.
`data`	object	JSON object containing event-specific data.
`created_at`	string	Creation timestamp.
`updated_at`	string	Last update timestamp.

Event types use canonical dot notation, such as payment_intent.succeeded. Delivery may be duplicated or arrive out of order, so process by event ID and compare resource state before taking an irreversible action.

Events

API Endpoints

API Endpoint Reference

Attributes

On this page

Full Explorer