Skip to main content
PUT
/
webhooks
/
{webhookID}
Update a webhook
curl --request PUT \
  --url https://api.bridge.xyz/v0/webhooks/{webhookID} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "status": "active",
  "event_categories": [
    "customer"
  ]
}
'
{
  "id": "wep_123",
  "url": "https://my_updated_endpoint.xyz/hooks",
  "status": "active",
  "public_key": "-----BEGIN PUBLIC KEY-----\\nFJJ3hFnaPLmxxG4a5w0BAQEFAAOCAQ8AMIIBCgKCAQEAtYhc6PV2LOs/nqDRHi0B\\nMKTsdMLHtg58a1NDxaYfw4IZJ3hpy1qIFUgt5X0HhCYZE0Y40MyLGIejPyitEjYw\\ni9/aE+9F/PN+btqN7OK6cVuF9s/R9cZCtNc27UdTQXrUO5T8GXNAMmRr0KFh8yPv\\nfIgpoZn5ZhnyRbZpDvrxHzLmcZJFAX8Ca+KZLzgGVybEqJtP6fKAT0zrrUS1z44s\\nRDOLiXl543cRAmBnUyrT6cXiNz/PNbm4zRK5Nx7LGxBFrCWQCao4Yi8hrwWsnHxg\\n0Tcy3UyZhAcgL6ydVJfLD5x58Ri4BN32WPBtgSSO6JxZZwCiX0d1BOgq7+eNgmzN\\nJQIDAQAB\\n-----END PUBLIC KEY-----\\n",
  "event_categories": [
    "customer",
    "liquidation_address",
    "virtual_account",
    "virtual_account.activity",
    "card_account",
    "card_transaction",
    "card_withdrawal",
    "posted_card_account_transaction"
  ]
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
webhookID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Body

application/json

Updated webhook endpoint object

​
url
string

The new HTTPS URL that Bridge will send events to.

Minimum string length: 1
​
status
enum<string>

The new status of the webhook endpoint. If set to "active", the webhook will be enabled and will send requests to the new URL. If set to "disabled", the webhook will be disabled and will not send requests to the URL.

Available options:
active,
disabled
​
event_categories
enum<string>[]

The list of event categories that the webhook endpoint will receive. Note that if modified, the webhook endpoint will receive events for new categories only from the current point onwards.

The category of the webhook event

Available options:
customer,
kyc_link,
liquidation_address.drain,
static_memo.activity,
transfer,
virtual_account.activity,
card_account,
card_transaction,
card_withdrawal,
posted_card_account_transaction

Response

Successful webhook object response

​
id
string
required

An identifier that uniquely identifies the webhook endpoint

​
url
string
required

The URL that the webhook will send events to

​
status
enum<string>
required

The status of the webhook. Only active webhooks will receive events automatically.

Available options:
active,
disabled,
deleted
​
public_key
string
required

The public key (in PEM format) that should be used to verify the authenticity of webhook events

​
event_categories
enum<string>[]

The list of event categories that the webhook endpoint will receive

The category of the webhook event

Available options:
customer,
kyc_link,
liquidation_address.drain,
static_memo.activity,
transfer,
virtual_account.activity,
card_account,
card_transaction,
card_withdrawal,
posted_card_account_transaction