added

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.

OperationAPI endpoint
Get events catalogGET /v3/events/catalog
Get list of event notificationsGET /v3/events/subscription/{subscriptionId}
Resend an eventPOST /v3/events/subscription/{subscriptionId}/event/{eventId}
Create a subscriptionPOST /v3/subscriptions
Send a test subscription eventPOST /v3/subscriptions/{subscriptionId}/test
Get subscription detailsGET /v3/subscriptions/{subscriptionId}
Get list of subscriptionsGET /v3/subscriptions
Update a subscriptionPATCH /v3/subscriptions/{subscriptionId}
Replace a subscriptionPUT /v3/subscriptions/{subscriptionId}
Delete a subscriptionDELETE /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.