Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

The table below shows the structure of every webhook notification generated by the Fireblocks webhook service.
FieldTypeDescription
idUUIDUnique identifier of the object.
resourceIdstringOptional: the ID of the entity that triggered the event (e.g., txId).
webhookIdUUIDThe ID of the client-side endpoint.
workspaceIdUUIDThe ID of the workspace that generated the webhook notification.
eventTypestring (enum)The type of event that triggered the webhook notification.
createdAttimestampTime at which the object was created, measured in milliseconds since the Unix epoch.
dataobjectThe object containing the data associated with the event.

Example notifications

vault_account.asset.added notification

{
  "id": "........-....-....-....-............",
  "workspaceId": "........-....-....-....-............",
  "eventType": "vault_account.asset.added",
  "createdAt": 1754494189479,
  "data": {
    "accountId": "21",
    "accountName": "test6",
    "assetId": "XRP_TEST"
  }
}

transaction.created notification (with resourceId)

{
  "id": "........-....-....-....-............",
  "resourceId": "........-....-....-....-............",
  "webhookId": "........-....-....-....-............",
  "workspaceId": "........-....-....-....-............",
  "eventType": "transaction.created",
  "createdAt": 1754229343763,
  "data": {
    "id": "........-....-....-....-............",
    "createdAt": 1754229343505,
    "lastUpdated": 1754229343505,
    "assetId": "XRP_TEST",
    "source": {
      "id": "0",
      "type": "VAULT_ACCOUNT",
      "name": "Default",
      "subType": ""
    },
    "destination": {
      "id": "1",
      "type": "VAULT_ACCOUNT",
      "name": "1",
      "subType": ""
    },
    "amount": 11,
    "fee": -1,
    "networkFee": -1,
    "netAmount": -1,
    "sourceAddress": "",
    "destinationAddress": "",
    "destinationAddressDescription": "",
    "destinationTag": "",
    "status": "SUBMITTED",
    "txHash": "",
    "subStatus": "",
    "signedBy": [],
    "createdBy": "........-....-....-....-............",
    "rejectedBy": "",
    "amountUSD": 11,
    "addressType": "",
    "note": "",
    "exchangeTxId": "",
    "requestedAmount": 11,
    "feeCurrency": "XRP_TEST",
    "operation": "TRANSFER",
    "customerRefId": null,
    "amountInfo": {
      "amount": "11",
      "requestedAmount": "11",
      "amountUSD": "11.00"
    },
    "feeInfo": {},
    "destinations": [],
    "externalTxId": null,
    "blockInfo": {},
    "signedMessages": [],
    "assetType": "BASE_ASSET"
  }
}