New v3 API endpoints for webhooks

You can now use the BILL webhooks to subscribe to and receive real time notifications, for events, such as create a vendor, update a vendor, or create a payment.

🚧
BILL webhooks API is currently in BETA
The BILL webhooks API is currently in BETA and is subject to improvements and changes. All improvements and changes will be documented.

When you subscribe to BILL events, you provide a location URL for where you want to receive notifications. BILL sends a notification to that URL each time a subscribed event is triggered.

📘
NOTE
The base URL for the BILL webhook API is https://gateway.stage.bill.com/connect-events.

Webhook operations

We have introduced a set of webhook API endpoints.

Operation	API endpoint
Get events catalog	`GET /v3/events/catalog`
Get list of event notifications	`GET /v3/events/subscription/{subscriptionId}`
Resend an event	`POST /v3/events/subscription/{subscriptionId}/event/{eventId}`
Create a subscription	`POST /v3/subscriptions`
Send a test subscription event	`POST /v3/subscriptions/{subscriptionId}/test`
Get subscription details	`GET /v3/subscriptions/{subscriptionId}`
Get list of subscriptions	`GET /v3/subscriptions`
Update a subscription	`PATCH /v3/subscriptions/{subscriptionId}`
Replace a subscription	`PUT /v3/subscriptions/{subscriptionId}`
Delete a subscription	`DELETE /v3/subscriptions/{subscriptionId}`

The events catalog includes events for vendors, bills, and payments.

vendor.created
vendor.updated
vendor.archived
vendor.restored
bill.created
bill.updated
bill.archived
bill.restored
payment.updated

See Webhooks for more information.