List Webhook Event Types

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": "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": "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."
    }
  ]
}

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), 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.

⌘I

API overview

Accounts

Addresses

Automations

Transfers

Financial institutions

Webhooks

Tokenization

List Webhook Event Types

Path parameters

Example request

Example response

Subscribing with wildcards

​Path parameters

​Example request

​Example response

​Subscribing with wildcards

Path parameters

Example request

Example response

Subscribing with wildcards