List Webhook Event Types

Discover the webhook event types supported by Brale for a given account.

GET /accounts/{account_id}/webhooks/event_types

Required scope: webhooks:read.

Path parameters

Name	Type	Description
account_id	string	The Brale account whose supported event types you want to discover.

Example request

curl https://api.brale.xyz/accounts/{account_id}/webhooks/event_types \
  -H "Authorization: Bearer {access_token}"

Example response

{
  "event_types": [
    {
      "event_type": "address.created",
      "summary": "Emitted when a wallet or bank account is added to an account."
    },
    {
      "event_type": "address.ready",
      "summary": "Emitted when a wallet or bank account is ready to use."
    },
    {
      "event_type": "transfer.created",
      "summary": "Emitted when a transfer (token order) is created."
    },
    {
      "event_type": "transfer.completed",
      "summary": "Emitted when a transfer (token order) reaches complete status."
    },
    {
      "event_type": "transfer.canceled",
      "summary": "Emitted when a transfer (token order) is canceled."
    },
    {
      "event_type": "transfer.failed",
      "summary": "Emitted when a transfer (token order) reaches failed status."
    },
    {
      "event_type": "transfer.refunding",
      "summary": "Emitted when a refund for a transfer (token order) starts."
    },
    {
      "event_type": "transfer.refunded",
      "summary": "Emitted when a refund for a transfer (token order) completes."
    },
    {
      "event_type": "payment.completed",
      "summary": "Emitted when a payment reaches complete status."
    },
    {
      "event_type": "account.verification.documents_required",
      "summary": "Emitted when an account requires additional verification documents."
    },
    {
      "event_type": "account.verification.completed",
      "summary": "Emitted when account verification reaches a completed state."
    },
    {
      "event_type": "account.verification.rejected",
      "summary": "Emitted when account verification is declined."
    }
  ]
}

Subscribing with wildcards

When you create or update a subscription, the events array accepts either a concrete event type from the list above or a namespace wildcard of the form <namespace>.*. For example, transfer.* subscribes to all transfer.* events (transfer.created, transfer.completed, transfer.canceled, transfer.failed, transfer.refunding, transfer.refunded), address.* subscribes to address.created and address.ready, and account.* subscribes to all account.* events including account.verification.* variants.

Wildcards are supported for every event family Brale exposes. New events added to a family in the future are automatically included in any matching wildcard subscription — no subscription update required.

See Create Webhook Subscription — Wildcard event subscriptions for full details, and the Webhooks overview for how subscriptions and event delivery work.