Skip to main content
PATCH
/
webhooks
/
registrations
/
{registrationId}
/
status
Enable or disable a webhook registration
curl --request PATCH \
  --url https://sandbox.trybraid.xyz/webhooks/registrations/{registrationId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active",
  "disabledReason": "Rotating credentials"
}
'
{
  "id": "1e9b4d42-0e0d-4a0e-9c55-3d6a1df3b9c1",
  "url": "https://api.partner.com/webhooks/braid",
  "status": "disabled",
  "eventTypes": [
    "portfolio_wallet.balance.updated"
  ],
  "description": "Alerts our ledger service when balances change",
  "createdAt": "2026-02-08T18:04:10.123Z",
  "disabledAt": "2026-02-08T18:10:00.000Z",
  "disabledReason": "Rotating credentials"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
registrationId
string
required

Body

application/json
​
status
enum<string>
required
Available options:
active,
disabled
​
disabledReason
string
Example:

"Rotating credentials"

Response

Updated webhook registration

​
id
string
​
url
string<uri>
​
status
string
​
eventTypes
string[]
​
description
string | null
​
createdAt
string<date-time>
​
disabledAt
string<date-time> | null
​
disabledReason
string | null