Description
The Events API group allows users to monitor and retrieve real-time notifications about activities related to accounts, payment intents, payouts, and other resources across the platform. This resource is vital for tracking changes, ensuring synchronization with external systems, and responding to key actions like successful payments or failed payouts.
API Endpoints
- Get Event: Retrieves the details of a specific event by its ID.
- List Events: Returns a paginated list of events with optional filtering.
API Endpoint Reference
| Method | Endpoint | Description |
|---|
| GET | /v1/events/:id | Retrieves the details of a specific event. |
| GET | /v1/events | Lists all events with filters. |
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 | Event type (e.g., 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. |