Skip to main content

Webhook Event Reference

Coming with the Webhooks v2 launch

This page is a stub for the merchant-configurable webhook subscriptions launching alongside the Webhooks product. Full per-event payload schemas, example JSON, and source references arrive in an upcoming release once the checkout delivery engine ships.

Today: session-level webhooks (session.succeeded, session.failed, session.expired, refund.created) are documented at Webhooks. Those will continue to work — Webhooks v2 adds a richer event catalog on top, not a replacement.

Event keys (v1 catalog — shape pending checkout delivery engine)

The v1 event catalog shipping with Webhooks v2 exposes 15 keys across three resource families. The canonical list is lib/webhook-events.ts in the merchant-app repo; this page will gain one anchor per key with payload schema + example JSON in an upcoming release.

Charge events

EventDescription
charge.succeededA charge completed successfully. Fires after the buyer finishes checkout and the processor settles the charge.
charge.failedA charge attempt failed. Includes failure_code and failure_message.
charge.refundedA charge was refunded (full or partial).

Payment intent events

EventDescription
payment_intent.succeededA payment intent reached terminal success.
payment_intent.failedA payment intent reached terminal failure.
payment_intent.cancelledA payment intent was cancelled before completion.

Dispute events

EventDescription
dispute.createdA new dispute was opened by the card network.
dispute.wonA dispute resolved in the merchant's favor.
dispute.lostA dispute resolved against the merchant.

Application / merchant lifecycle events

EventDescription
application.approvedA merchant application was approved.
application.deniedA merchant application was denied.
merchant.ready_for_paymentsA merchant has completed boarding and is cleared to accept live payments.

Payout events

EventDescription
payout.paidA payout was sent to the merchant's bank account.
payout.failedA payout attempt failed.