Update webhook endpoint

Idempotency Supported

Updates the configuration of an existing webhook endpoint using its unique identifier. You can use this API to change properties such as the name, URL, subscribed events, authentication credentials, or API version. This is useful when rotating endpoints, updating destination URLs, or modifying which events your system listens to.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/webhook_endpoints/{webhook-endpoint-id}

Input Parameters

name

optional, string, max chars=50

A name to identify the webhook endpoint.

api_version

optional, enumerated string, default=v2

The API version used to format the webhook payload. Ensure this version matches the client library used by your webhook server.

Enum Values

If selected, the payload includes only attributes from API v1 resources.

If selected, the payload includes only attributes from API v2 resources.

url

optional, string, max chars=512

The target URL where webhook notifications will be sent.

Note Only URL ports 80, 443, 8080, or 8443 are allowed.

primary_url

optional, boolean, default=false

Controls whether card-related resources are included in the webhook payload. Card details are always masked.

send_card_resource

optional, boolean, default=false

Specifies whether card-related resources should be included in the webhook payload.

basic_auth_password

optional, string, max chars=250

The password used for basic authentication to secure webhook delivery.

basic_auth_username

optional, string, max chars=250

Username for basic authentication used to secure webhook delivery.

disabled

optional, boolean, default=false

Indicates whether the webhook endpoint is disabled. Set to true to disable the endpoint, set to false to enable the endpoint.

enabled_events

optional, enumerated string

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.

Enum Values

coupon_created

Sent when a coupon is created.

coupon_updated

Sent when a coupon is changed.

coupon_deleted

Sent when a coupon is deleted.

coupon_set_created

Sent when a coupon set is created.

coupon_set_updated

Sent when a coupon set is changed.

Returns

webhook_endpoint

Webhook endpoint object

Resource object representing webhook_endpoint