Webhooks provide the ability to receive real-time data updates about various platform events. When a registered event occurs, the system sends a snapshot of the entity that changed to the configured endpoint URL.
Webhook Schema
Field
Description
Type
id
Unique identifier (UUID)
String
name
Descriptive name for this webhook configuration
String
url
Target URL endpoint where webhook notifications will be sent
String
entity
Type of entity to monitor for events (e.g., bill, order, billing)
String
events
Array of specific events to trigger webhook notifications for this entity
Array
params
Additional parameters or configuration options for the webhook
Object
verb
HTTP method used for webhook requests (e.g., POST, PUT)
String
created_at
Indicates when the record was created in ISO8601 format
String
updated_at
Indicates when the record was last updated in ISO8601 format