Skip to main content
GET
/
webhook_events
List webhook events
curl --request GET \
  --url https://api.bridge.xyz/v0/webhook_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"
    }
  ],
  "count": 123
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
starting_after
string

Cursor for forward pagination. Returns events after the specified event ID.

​
ending_before
string

Cursor for backward pagination. Returns events before the specified event ID.

​
limit
integer
default:100

Maximum number of events to return (1-500, default 100).

Required range: 1 <= x <= 500
​
category
enum<string>

Filter events by category.

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

Response

List of webhook events

​
data
object[]
required
​
count
integer
required

Number of webhook events returned in this response