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": [
{
"summary": "A list of events for the webhook endpoint",
"value": {
"data": {
"type": "array",
"minItems": 0,
"items": [
{
"api_version": "v0",
"event_id": "wh_tmneA3b1rTv1q4gkvmPU53n",
"event_developer_id": "2d127766-02fa-44b0-9fc8-a67665dbf109",
"event_sequence": 1,
"event_category": "transfer",
"event_type": "transfer.deleted",
"event_object_id": "cc598628-29ab-448e-851f-7aaffb1a1171",
"event_object_status": null,
"event_object": {
"id": "cc598628-29ab-448e-851f-7aaffb1a1171",
"state": "awaiting_funds",
"amount": "50.0",
"source": {
"currency": "usdc",
"from_address": "0xd48f4e51c2fcd1c8489eb1a64588b29b76ad0a3f",
"payment_rail": "ethereum"
},
"receipt": {
"gas_fee": "0.0",
"exchange_fee": "0.0",
"final_amount": "50.0",
"developer_fee": "0.0",
"initial_amount": "50.0",
"subtotal_amount": "50.0",
"url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"
},
"currency": "usd",
"created_at": "2024-05-02T17:48:19.366Z",
"updated_at": "2024-05-02T17:48:19.366Z",
"destination": {
"currency": "usd",
"payment_rail": "ach",
"external_account_id": "24fd61e9-80b6-464a-b5ee-9f7a521cb1f0"
},
"on_behalf_of": "474c32b3-f3d6-43e3-92ce-a7d4e07fa0a4",
"developer_fee": "0.0",
"source_deposit_instructions": {
"amount": "50.0",
"currency": "usdc",
"to_address": null,
"from_address": "0xd48f4e51c2fcd1c8489eb1a64588b29b76ad0a3f",
"payment_rail": "ethereum"
}
},
"event_object_changes": {
"state": [
"pending",
"canceled"
],
"updated_at": [
"2024-05-02T15:14:02.842Z",
"2024-05-02T15:15:07.163Z"
]
},
"event_created_at": "2024-05-02T17:48:19.465Z"
}
]
}
}
}
]
}

Authorizations

Api-Key
string
header
required

Path Parameters

webhookID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

200
application/json

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

The response is of type object.