A webhook endpoint receives real-time notifications from your Chargebee site when specific events occur, such as invoice generation, payment failures, or subscription updates. It allows your application, server, or third-party service to automatically respond to these changes, eliminating the need for manual checks or polling the API. Each webhook endpoint includes details such as a unique ID, target URL, list of subscribed events, and status. You can manage webhook endpoints using the Chargebee dashboard or the API.
Note You can create up to five webhook endpoints per site.
Sample Webhook endpointJSON
API Index URL
Webhook endpoints attributes
Controls whether card-related resources are included in the webhook payload. Card details are always masked.
Indicates whether the webhook endpoint is disabled. If true
, the endpoint is disabled; if false
, it is enabled.
Indicates whether this is the primary webhook endpoint. If only one endpoint exists, it is considered primary by default.
Specifies the API version used to format the webhook payload. Make sure this version matches the client library version used by your webhook server.
If selected, the webhook payload includes only attributes from API v1 resources.
If selected, the webhook payload includes only attributes from API v2 resources.
Indicates the response schema used in the webhook payload, based on the product catalog version configured for the site.
Note
This field is only applicable if the site is in compat mode.
The webhook payload follows the Product Catalog 1.0 schema and uses the Plans and Addons model.
The webhook payload follows the Product Catalog 2.0 schema and uses the Items API model .
The webhook payload uses a schema compatible with both Product Catalog 1.0 and 2.0. This is applicable only to sites automatically upgraded to Product Catalog 2.0.
The types of events that trigger this webhook. For a complete list, see event types .