POST /webhook_endpoints

Create a new webhook API endpoint on your Chargebee Site.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`basic_auth_password`	String	No	The password used for basic authentication to secure webhook delivery.
`name`	String	Yes	A name to identify the webhook endpoint.
`url`	String	Yes	The target URL where webhook notifications will be sent.
`api_version`	String	No	The API version used to format the webhook payload. Ensure this version matches the client library used by your webhook server * v1 - If selected, the payload includes only attributes from API v1 resources. * v2 - If selected, the payload includes only attributes from API v2 resources. Possible values: `"v1"` `"v2"` Default value: "v2"
`disabled`	Boolean	No	Indicates whether the webhook endpoint is disabled. Set to `true` to disable the endpoint, set to `false` to enable the endpoint. Default value: false
`basic_auth_username`	String	No	Username for basic authentication used to secure webhook delivery.
`primary_url`	Boolean	No	Indicates whether this webhook is marked as the primary endpoint. If only one exists, it is primary by default. Default value: false
`send_card_resource`	Boolean	No	Controls whether card-related resources are included in the webhook payload. Card details are always masked. Default value: false
`enabled_events[]`	Array	No	A list of event types that trigger this webhook. Note If this field is left empty, the webhook will enable all event types by default.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.