Overview
Each event is structured as an object with a type and a data sub-object that holds the transaction ID and other related information. Your endpoint must check the event type and parse the payload of each event.
List of events & descriptions
Category | Event Type | Description |
---|---|---|
Transactions |
transaction.created
|
Triggered when any new transaction is identified in the workspace. |
Transactions |
transaction.status.updated
|
Triggered when there is any change in a transaction's status or when Fireblocks detects an update to the number of confirmations. |
Transactions |
transaction.approval_status.updated
|
Triggered on every approval based on the transaction authorization policy. |
Transactions |
transaction.network_records.processing_completed
|
Triggered when the processing of all the network records is completed. The transaction data contains all the transaction's network records. |
Whitelist |
external_wallet.asset.added
|
Triggered when any asset is added to an external wallet. |
Whitelist |
external_wallet.asset.removed
|
Triggered when any asset is removed from an external wallet. |
Whitelist |
internal_wallet.asset.added
|
Triggered when any asset is added from an internal wallet. |
Whitelist |
internal_wallet.asset.removed
|
Triggered when any asset is removed from an internal wallet. |
Whitelist |
contract_wallet.asset.added
|
Triggered when any asset is added to a contract wallet. |
Whitelist |
contract_wallet.asset.removed
|
Triggered when any asset is removed from a contract wallet. |
Wallet |
vault_account.created
|
Triggered when a vault account is created. |
Wallet |
vault_account.asset.added
|
Triggered when any asset is added to a vault account. |
Wallet |
vault_account.asset.balance_updated
|
Triggered when a vault account's asset balance is updated. |
Wallet |
embedded_wallet.created
|
Triggered when a a wallet is created within an EW tenant. |
Embedded Wallets |
embedded_wallet.status.updated
|
Triggered when a wallet status is updated within an EW tenant. |
Embedded Wallets |
embedded_wallet.account.created
|
Triggered when an account is created in an embedded wallet. |
Embedded Wallets |
vault_account.nft.balance_updated
|
Triggered when a vault account's NFT balance changes. |
Embedded Wallets |
embedded_wallet.asset.added
|
Triggered when an asset is added to an embedded wallet account. |
Embedded Wallets |
embedded_wallet.asset.balance_updated
|
Triggered when an embedded wallet’s asset balance changes. |
Embedded Wallets |
embedded_wallet.device.added
|
Triggered when a new device has requested to join a wallet |
CeFi |
exchange_account.added
|
Triggered when any exchange account is added. |
CeFi |
fiat_account.added
|
Triggered when any fiat account is added. |
Network Connection |
network_connection.added
|
Triggered when any Fireblocks network connection is added. |
Network Connection |
connection.removed
|
Triggered when a Fireblocks Network connection is removed. |
Network Connection |
connection.request.waiting_peer_approval
|
Triggered when a Fireblocks Network connection request is approved by initiator. |
Network Connection |
connection.request.rejected_by_peer
|
Triggered when a Fireblocks Network connection request is rejected. |
Smart Transfer |
ticket.created
|
Triggered when a smart transfer ticket is created. |
Smart Transfer |
ticket.submitted
|
Triggered when a smart transfer ticket is submitted. |
Smart Transfer |
ticket.expired
|
Triggered when a smart transfer ticket expires. |
Smart Transfer |
ticket.canceled
|
Triggered when a smart transfer ticket is canceled. |
Smart Transfer |
ticket.fulfilled
|
Triggered when a smart transfer ticket is funded. |
Smart Transfer |
ticket.counterparty.added
|
Triggered when a counterparty is added to a smart transfer ticket. |
Smart Transfer |
ticket.term.added
|
Triggered when a Smart Transfer ticket term is added. |
Smart Transfer |
ticket.term.updated
|
Triggered when a Smart Transfer ticket term is updated. |
Smart Transfer |
ticket.term.deleted
|
Triggered when a Smart Transfer ticket term is deleted. |
Smart Transfer |
ticket.term.deleted
|
Triggered when a Smart Transfer ticket term is deleted. |
Smart Transfer |
ticket.term.funded
|
Triggered when a Smart Transfer ticket term is funded. |
Smart Transfer |
ticket.term.manually_funded
|
Triggered when a Smart Transfer ticket term is manually funded. |
Smart Transfer |
ticket.term.funding_failed
|
Triggered when a Smart Transfer ticket term’s funding fails. |
Smart Transfer |
ticket.term.funding_canceled
|
Triggered when a Smart Transfer ticket term’s funding is canceled. |
Smart Transfer |
ticket.term.funding_failed
|
Triggered when a Smart Transfer ticket term’s funding fails. |
Smart Transfer |
ticket.term.funding_completed
|
Triggered when a Smart Transfer ticket term funding is funded. |
Smart Transfer |
ticket.term.transaction_status_changed
|
Triggered when a Smart Transfer ticket term’s status changes. |
Off Exchange |
settlement.created
|
A notification is sent when a new settlement is initiated in the workspace. |
Off Exchange |
collateral.status.updated
|
A notification is sent to the exchange once a collateral user is created and has a pairing token available. |
Examples
transaction.created event
{
"eventType": "TRANSACTION_CREATED",
"tenantId”: ".........-.....-....-....-...........",
"resourceId”: ".........-.....-....-....-...........",
"eventVersion”: 1,
"timestamp": 1679651214621,
"data": {
"id": "........-....-....-....-............",
"createdAt": 1679651104380,
"lastUpdated": 1679651104380,
"assetId": "WETH_TEST3",
"source": {
"id": "0",
"type": "VAULT_ACCOUNT",
"name": "Main",
"subType": ""
},
"destination": {
"id": "12",
"type": "VAULT_ACCOUNT",
"name": "MintBurn",
"subType": ""
},
"amount": 0.001,
"sourceAddress": "",
"destinationAddress": "",
"destinationAddressDescription": "",
"destinationTag": "",
"status": "SUBMITTED",
"txHash": "",
"subStatus": "",
"signedBy": [],
"createdBy": ".........-.....-....-....-...........",
"rejectedBy": "",
"amountUSD": null,
"addressType": "",
"note": "",
"exchangeTxId": "",
"requestedAmount": 0.001,
"feeCurrency": "ETH_TEST3",
"operation": "TRANSFER",
"customerRefId": null,
"amountInfo": {
"amount": "0.001",
"requestedAmount": "0.001"
},
"feeInfo": {},
"destinations": [],
"externalTxId": null,
"blockInfo": {},
"signedMessages": [],
"assetType": "ERC20"
}
}
transaction.status.updated event
{
"type": "TRANSACTION_STATUS_UPDATED",
"tenantId”: ".........-.....-....-....-...........",
"timestamp": 1679651214621,
"data": {
"id": "........-....-....-....-............",
"createdAt": 1680014718734,
"lastUpdated": 1680014729691,
"assetId": "TRX_USDT",
"source": {
"id": "",
"type": "UNKNOWN",
"name": "External",
"subType": ""
},
"destination": {
"id": "2107",
"type": "VAULT_ACCOUNT",
"name": "Main",
"subType": ""
},
"amount": 370,
"networkFee": 27.2559,
"netAmount": 370,
"sourceAddress": "",
"destinationAddress": "",
"destinationAddressDescription": "",
"destinationTag": "",
"status": "COMPLETED",
"txHash": "e9e1asdade125be06638c8675fdsfsdc79594dd45ff095b7683c3f03b81a9389684",
"subStatus": "CONFIRMED",
"signedBy": [],
"createdBy": "",
"rejectedBy": "",
"amountUSD": 0,
"addressType": "",
"note": "",
"exchangeTxId": "",
"requestedAmount": 370,
"feeCurrency": "TRX",
"operation": "TRANSFER",
"customerRefId": "........-....-....-....-............",
"numOfConfirmations": 1,
"amountInfo": {
"amount": "370",
"requestedAmount": "370",
"netAmount": "370",
"amountUSD": null
},
"feeInfo": {
"networkFee": "27.2559"
},
"destinations": [],
"externalTxId": null,
"blockInfo": {
"blockHeight": "49800684",
"blockHash": "0000000002f7e5ece07efd8dfnjngfh76dda5f2645a9aba5e6h4534ba1bc7d97a8e2"
},
"signedMessages": [],
"amlScreeningResult": {
"screeningStatus": "BYPASSED",
"bypassReason": "PASSED_BY_POLICY",
"timestamp": 1680014729455
},
"assetType": "TRON_TRC20"
}
}
{
"eventType": "TRANSACTION_STATUS_UPDATED",
"tenantId”: ".........-.....-....-....-...........",
"resourceId”: ".........-.....-....-....-...........",
"eventVersion”: 1,
"timestamp": 1679651214621,
"data": {
"id": "........-....-....-....-............",
"createdAt": 1679651104380,
"lastUpdated": 1679651104380,
"assetId": "WETH_TEST3",
"source": {
"id": "0",
"type": "VAULT_ACCOUNT",
"name": "Main",
"subType": ""
},
"destination": {
"id": "12",
"type": "VAULT_ACCOUNT",
"name": "MintBurn",
"subType": ""
},
"amount": 0.001,
"sourceAddress": "",
"destinationAddress": "",
"destinationAddressDescription": "",
"destinationTag": "",
"status": "SUBMITTED",
"txHash": "",
"subStatus": "",
"signedBy": [],
"createdBy": ".........-.....-....-....-...........",
"rejectedBy": "",
"amountUSD": null,
"addressType": "",
"note": "",
"exchangeTxId": "",
"requestedAmount": 0.001,
"feeCurrency": "ETH_TEST3",
"operation": "TRANSFER",
"customerRefId": null,
"amountInfo": {
"amount": "0.001",
"requestedAmount": "0.001"
},
"feeInfo": {},
"destinations": [],
"externalTxId": null,
"blockInfo": {},
"signedMessages": [],
"assetType": "ERC20"
}
}