Subscribe to webhook events to receive real-time notifications when bills or reports are created, completed, or deleted.
Parameter | Type | Required | Description |
---|---|---|---|
events | array | Yes | List of event types to subscribe to |
endpoint | string | Yes | Your webhook endpoint URL (must use HTTPS) |
protocol | string | Yes | Protocol for webhook delivery (only “https” is supported) |
authToken | string | No | Optional authentication token to include in webhook requests |
bill.created
- New bill createdbill.completed
- Entire bill completed (all reports finished)bill.deleted
- Bill deleted from systemreport.completed
- Individual report completedJWT token obtained from the authentication endpoint
Successful webhook
The response is of type object
.