v1

latestOpenAPI 3.1.02026-08-042453938.9 KB

Webhooks

List webhook event types

Get all available webhook event types with descriptions. Requires a secret key (sk_). Public keys (pk_) will receive a 403 error.

get/v1/webhooks/events

Response

Available event types

eventsstring[]

List of all available event types

descriptionobject

Human-readable descriptions for each event type

Example response

{
  "events": [
    "charge.succeeded",
    "charge.failed",
    "customer.balance.low",
    "customer.deposit.confirmed"
  ],
  "description": {
    "charge.succeeded": "Charge confirmed on-chain - unlock service, update billing UI",
    "charge.failed": "Charge failed - trigger retries, alerts, user notification",
    "customer.balance.low": "Customer drops below configured threshold - prevent surprise outages"
  }
}