Get all webhook endpoints

curl --request GET \
  --url https://api.bridge.xyz/v0/webhooks \
  --header 'Api-Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "url": "<string>",
      "status": "active",
      "public_key": "<string>",
      "event_categories": [
        "customer"
      ]
    }
  ]
}

GET

webhooks

curl --request GET \
  --url https://api.bridge.xyz/v0/webhooks \
  --header 'Api-Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "url": "<string>",
      "status": "active",
      "public_key": "<string>",
      "event_categories": [
        "customer"
      ]
    }
  ]
}

Authorizations

Api-Key

string

header

required

Response

List of webhook endpoints (the returned list is empty if none found)

data

object[]

required

Show child attributes

data.id

string

required

An identifier that uniquely identifies the webhook endpoint

data.url

string

required

The URL that the webhook will send events to

data.status

enum<string>

required

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

Available options:

active,

disabled,

deleted

data.public_key

string

required

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

data.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

Get all funds requests Create a webhook endpoint

⌘I

Endpoints

Authorizations

Response