BRbrale
Webhooks

Create webhook subscription

Changed on

Registers a destination URL and one or more event types. The signing secret is returned once in the response.

post/accounts/{account_id}/webhooks

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: webhooks:write, webhooks:read

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

eventsstring[] required

Event types to subscribe to. Supports concrete types (e.g. transfer.created) and namespace wildcards (e.g. transfer.* for all transfer events). See the supported event types endpoint.

urlstring required

HTTPS URL to receive signed webhook POST requests

Response

Created

eventsstring[] required
idstring required

ID of the resource

sharedSecretstring required

Signing secret (Base64 Encoded). Returned only on create; store it securely to verify signatures.

status'active' | 'archived' required

Subscription lifecycle: active deliveries or archived (no longer used).

urlstring required

Example response

{
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC"
}

Changes

  • d934fd29acc3Revision changes
    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

  • 0f6e2639fbe2Revision changes
    • info

      endpoint added