Types of events
We currently send multiple types of events. This section will provide a quick overview of all the events we provide.
Webhooks can trigger a variety of events based on actions in the system. Each event type provides specific data and insights into system activities, helping you integrate and automate processes efficiently. Below is an overview of the event types:
Event categories
Tracks the lifecycle of payments, including creation, distribution and remittance.
Examples:
payment_loading_requested, payment_loading_completed, payment_distribution_requested, payment_distribution_completed, payment_remittance_ready etc.
Tracks the lifecycle of batch payments, including creation, loading, and distribution.
Examples:
batch_created, batch_held, batch_held, batch_loading_requested, batch_loaded, batch_distributed
Tracks
Tracks
Tracks the fax lifecycle.
Event envelope
Each event request body follows a standardized envelope format for all events. This format ensures that all events follow a standardized structure, making it easier to process and understand them.
| Field | Description | Example |
|---|---|---|
| id | The identifier of the object the event is related to (e.g., batch id, payment id etc.) | 45b93ecf-c718-4255-8485-10228f ca6713 |
| source | The source of the event | https://example.com |
| specVersion | The version of the CloudEvent spec | 1.0 |
| type | The type of the event | batch_created |
| dataContentType | Content type of the data | application/json |
| data | The payload of the event | dynamic JSON object |
| time | The date and time the event was created | 2024-12-02T15:24:40. 6048459Z |
| causationId | The identifier of the event | 134433a2-387d-48b8-9d7e-ddc7af8c705f |
Updated 9 months ago