An event, delivered to your endpoint
Each event is POSTed to every active endpoint of yours, in its mode, that
subscribes to its type. Verify Volume-Signature first (see "Webhooks"), answer
2xx within ten seconds, and dedupe on id. Anything but 2xx is tried again
with backoff for three days.
Header Parameters
t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
What an endpoint receives, and the test event's answer. data holds the
resources the event is about, as they were when it happened:
checkout_session for every payment event, with payment for
checkout.payment_detected and payment.confirmed (and credited_usd,
fee_usd on the latter), amount_received with amount_remaining or
amount_excess for invoice.underpaid and invoice.overpaid, and
webhook_endpoint for webhook_endpoint.test.
Response Body
Example Requests
What an endpoint receives, and the test event's answer. data holds the
resources the event is about, as they were when it happened:
checkout_session for every payment event, with payment for
checkout.payment_detected and payment.confirmed (and credited_usd,
fee_usd on the latter), amount_received with amount_remaining or
amount_excess for invoice.underpaid and invoice.overpaid, and
webhook_endpoint for webhook_endpoint.test.
/event