Webhook Schema
The webhook schema defines the structure of payloads sent by TransFi to notify your system about important events in real time.
These notifications are sent in real-time as JSON objects and are triggered at both the user and order levels.
Webhooks ensure your system stays updated with the latest status changes, providing all necessary details for seamless event processing.
Webhook Payload Structure
Each webhook payload contains the following top-level fields:
| Field | Type | Description |
|---|---|---|
entityType | String | Type of entity associated with the event. Possible values: user, order |
entityId | String | Unique identifier of the entity (userId or orderId) |
status | String | Current status of the entity at the time the event was triggered |
user | Object | User-related information associated with the event |
order | Object | Order-related information associated with the event |