Webhook Schema

The webhook schema defines the structure of payloads sent by TransFi to notify your system about key events. 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 key fields, offering crucial information about the event:

Field	Type	Description
entityType	String	Specifies the type of entity triggering the event (user-level or order-level).
entityId	String	Unique Identifier of the event (user, order).
status	String	Current status of the entity.
user	Object	Contains user information relevant to the event.
order	Object	Contains order information relevant to the event.

Supported Events

You can receive webhooks for the following events:

User Events
Order Events