List upcoming events

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

{
  "data": [
    {
      "api_version": "<string>",
      "event_id": "<string>",
      "event_developer_id": "<string>",
      "event_category": "customer",
      "event_type": "created",
      "event_object_id": "<string>",
      "event_object": {},
      "event_object_changes": {},
      "event_created_at": "2023-11-07T05:31:56Z",
      "event_sequence": 123,
      "event_object_status": "not_started"
    }
  ]
}

GET

webhooks

{webhookID}

events

List upcoming events

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

{
  "data": [
    {
      "api_version": "<string>",
      "event_id": "<string>",
      "event_developer_id": "<string>",
      "event_category": "customer",
      "event_type": "created",
      "event_object_id": "<string>",
      "event_object": {},
      "event_object_changes": {},
      "event_created_at": "2023-11-07T05:31:56Z",
      "event_sequence": 123,
      "event_object_status": "not_started"
    }
  ]
}

Authorizations

Api-Key

string

header

required

Path Parameters

webhookID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

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

data

object[]

required

Show child attributes

data.api_version

string

required

data.event_id

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

data.event_developer_id

string

required

The developer ID of the developer

data.event_category

enum<string>

required

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

data.event_type

enum<string>

required

The values here will be prefixed with the event_category. For example, a customer created event will be customer.created

Available options:

created,

updated,

updated.status_transitioned,

deleted,

canceled

data.event_object_id

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

data.event_object

object

required

The object that was affected by the event

data.event_object_changes

object

required

The changes that were made to the object

data.event_created_at

string<date-time>

required

data.event_sequence

integer

data.event_object_status

enum<string>

Available options:

not_started,

incomplete,

active,

rejected,

under_review,

manual_review,

awaiting_ubo,

approved,

awaiting_funds,

funds_received,

payment_submitted,

payment_processed,

in_review,

canceled,

error,

returned,

refunded,

undeliverable

Delete a webhook View logs

⌘I

Endpoints

Authorizations

Path Parameters

Response