Get the webhook event envelope schema
Webhooks
Get the webhook event envelope schema
Returns a representative example of the signed webhook payload every endpoint receives. Useful when building and type-checking a webhook handler; the live type will be one of the values from event-types.
GET
Get the webhook event envelope schema
Authorizations
Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.
Response
200 - application/json
API version that produced the event payload.
Example:
"2024-01-01"
Unix timestamp (seconds) when the event was created.
Example:
1717000000
Event payload envelope.
Unique event ID.
Example:
"evt_1A2B3C4D"
True for live-mode events, false for sandbox.
Example:
true
Context about the triggering API request.
Event type.
Available options:
customer.created, customer.updated, customer.deleted, purchase.created, purchase.activated, purchase.updated, purchase.trial_ending, purchase.trial_converted, purchase.suspended, purchase.past_due, purchase.cancellation_scheduled, purchase.cancelled, purchase.reactivated, purchase.expired, purchase.renewed, purchase.renewal_reminder, purchase.refunded, purchase.plan_changed, payment.succeeded, payment.failed, payment.refunded, payment.refund_failed, payment.refund_pending, payment.canceled, payment.disputed, payment.dispute_closed, payout.paid, payout.failed, checkout_session.created, checkout_session.completed, checkout_session.expired, customer.credit.topped_up, customer.credit.low_balance, customer.credit.exhausted, customer.credit.debited, customer.credit.granted, customer.credit.adjusted, customer.credit.auto_topup_failed, usage.charged, usage.recorded, usage.reset, product.created, product.updated, product.archived, plan.created, plan.updated, plan.archived Example:
"purchase.created"