For AI agents: a machine-readable documentation index is available at /llms.txt. Every documentation page is also available as Markdown by appending .md to its URL.

chargebee api

Gateway Webhook Log

A gateway webhook log is a record of a single webhook that a payment gateway sent to Chargebee, along with the response Chargebee returned to the gateway. Use gateway webhook logs to confirm that gateway notifications, such as asynchronous payment or refund updates, reached Chargebee, and to trace them to the related customer, invoice, or transaction.

Request and response bodies and headers are returned as stored, with sensitive values already masked. Logs are retained for 60 days.

Sample Gateway webhook logJSON

Gateway Webhook Log attributes

webhook_id

optional, string, max chars=100

Uniquely identifies the gateway webhook log.

url

optional, string, max chars=500

The Chargebee URL at which the webhook was received.

method

optional, string, max chars=100

The HTTP method of the webhook request, for example POST.

status_code

optional, string, max chars=100

The HTTP status code that Chargebee returned to the gateway, as a string. For example, "200".

gateway

optional, string, max chars=100

The payment gateway that sent the webhook, for example stripe or adyen.

id_at_gateway

optional, string, max chars=200

The gateway's reference for the transaction that the webhook is about, for example Adyen's pspReference. Chargebee uses this value to match the webhook to a transaction.

customer_handle

optional, string, max chars=100

The ID of the customer associated with the webhook, resolved from the matching transaction or payment intent.

invoice_handle

optional, string, max chars=100

The ID of the invoice associated with the webhook, resolved from the matching transaction.

transaction_handle

optional, string, max chars=100

The ID of the transaction that the webhook matched, resolved from id_at_gateway.

payment_method_handle

optional, string, max chars=100

The ID of the payment source associated with the webhook, resolved from the matching transaction.

gateway_credential_handle

optional, string, max chars=100

The ID of the gateway account associated with the webhook, resolved from the matching transaction or payment intent.

payment_attempt_handle

optional, string, max chars=100

The ID of the payment attempt associated with the webhook. Present when the webhook matches a payment attempt but not a transaction.

payment_intent_handle

optional, string, max chars=100

The ID of the payment intent associated with the webhook, resolved from the matching payment attempt.

payment_method_name

optional, string, max chars=100

The name of the payment method associated with the webhook.

request_body

optional, string, max chars=65k

The body of the webhook request sent by the gateway. Sensitive values are masked.

response_body

optional, string, max chars=65k

The body of the response that Chargebee returned to the gateway. Sensitive values are masked.

request_headers

optional, string, max chars=65k

The HTTP headers of the webhook request sent by the gateway. Sensitive values are masked.

response_headers

optional, string, max chars=65k

The HTTP headers of the response that Chargebee returned to the gateway. Sensitive values are masked.

received_at

optional, timestamp(UTC) in seconds

Timestamp indicating when Chargebee received the webhook.

response_time

optional, long

The time Chargebee took to process the webhook, in milliseconds.