Skip to main content
DELETE
/
webhooks
/
{webhookID}
Delete a webhook
curl --request DELETE \
  --url https://api.bridge.xyz/v0/webhooks/{webhookID} \
  --header 'Api-Key: <api-key>'
{
  "id": "wep_123",
  "url": "https://my_deleted_endpoint.xyz/hooks",
  "status": "deleted",
  "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"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
webhookID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

Successfully deleted webhook 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