Event Objects

TransactionCreated

ParameterTypeDescription
typestringTRANSACTION_CREATED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataTransactionDetailsAll the transaction information

TransactionStatusUpdated

ParameterTypeDescription
typestringTRANSACTION_STATUS_UPDATED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataTransactionDetailsAll the transaction information

TransactionApprovalStatusUpdated

ParameterTypeDescription
typestringTRANSACTION_APPROVAL_STATUS_UPDATED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataTransactionDetailsAll the transaction information

TransactionDetails

ParameterTypeDescription
idstringID of the transaction
assetIdstringTransaction asset
assetTypestringone of the following - XLM_ASSET
XDB_ASSET
TRON_TRC20
SOL_ASSET
HBAR_ERC20
FIAT
ERC721
ERC20
ERC1155
COMPOUND
BEP20
BASE_ASSET
ALGO_ASSET
sourceTransferPeerPathResponseSource of the transaction
destinationTransferPeerPathResponseFireblocks supports multiple destinations for UTXO-based blockchains. For other blockchains, this array will always be composed of one element
requestedAmountnumberThe amount requested by the user
amountInfoAmountInfoDetails of the transaction's amount in string format
feeInfoFeeInfoDetails of the transaction's fee in string format
amountnumberIf the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount
netAmountnumberThe net amount of the transaction, after fee deduction
amountUSDnumberThe USD value of the requested amount
serviceFeenumberThe total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount)
treatAsGrossAmountbooleanFor outgoing transactions, if true, the network fee is deducted from the requested amount
networkFeenumberThe fee paid to the network
createdAtnumberUnix timestamp
lastUpdatednumberUnix timestamp
statusTransactionStatusThe current status of the transaction
txHashstringBlockchain hash of the transaction
indexnumber[optional] For UTXO based assets this is the vOut, for Ethereum based, this is the index of the event of the contract call
subStatusTransactionSubStatusMore detailed status of the transaction
sourceAddressstringFor account based assets only, the source address of the transaction. (Note: This parameter will be empty for transactions that are not: CONFIRMING, COMPLETED, or REJECTED/FAILED after passing CONFIRMING status.)
destinationAddressstringAddress where the asset were transferred
destinationAddressDescriptionstringDescription of the address
destinationTagstringDestination tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat providers: Signet (by Signature), SEN (by Silvergate), or BLINC (by BCB Group)
signedByArray of stringsSigners of the transaction
createdBystringInitiator of the transaction
rejectedBystringUser ID of the user that rejected the transaction (in case it was rejected)
addressTypestring[ ONE_TIME, WHITELISTED ]
notestringCustom note of the transaction
exchangeTxIdstringIf the transaction originated from an exchange, this is the exchange tx ID
feeCurrencystringThe asset which was taken to pay the fee (ETH for ERC-20 tokens, BTC for Tether Omni)
operationTransactionOperationDefault operation is "TRANSFER"
amlScreeningResultAmlScreeningResultThe result of the AML screening
customerRefIdstringThe ID for AML providers to associate the owner of funds with transactions
numOfConfirmationsnumberThe number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy
networkRecordsArray of NetworkRecord objectsTransaction on the Fireblocks platform can aggregate several blockchain transactions, in such a case these records specify all the transactions that took place on the blockchain
replacedTxHashstringIn case of an RBF transaction, the hash of the dropped transaction
externalTxIdstringUnique transaction ID provided by the user
destinationsArray of DestinationsResponseFor UTXO based assets, all outputs specified here
blockInfoBlockInfoThe information of the block that this transaction was mined in, the blocks's hash and height
rewardsInfoRewardsInfoThis field is relevant only for ALGO transactions. Both srcRewrds and destRewards will appear only for Vault to Vault transactions, otherwise you will receive only the Fireblocks' side of the transaction
authorizationInfoAuthorizationInfoThe information about your Transaction Authorization Policy (TAP). For more information about the TAP, refer to this section in the Help Center
signedMessagesArray of SignedMessage objectsA list of signed messages returned for raw signing
extraParametersJSON objectProtocol / operation specific parameters
systemMessagesArray of SystemMessageInfo objectsA response from Fireblocks that communicates a message about the health of the process being performed. If this object is returned with data, you should expect potential delays or incomplete transaction statuses

VaultAccountAdded

ParameterTypeDescription
typestringVAULT_ACCOUNT_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataVaultAccountVault Account details

VaultAccountAssetAdded

ParameterTypeDescription
typestringVAULT_ACCOUNT_ASSET_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataAssetAddedDataVault-Account-Asset details

AssetAddedData

ParameterTypeDescription
accountIdstringThe ID of the vault account under which the wallet was added
tenantIdstringUnique id of your Fireblocks' workspace
accountNamestringThe name of the vault account under which the wallet was added
assetIdstringWallet's asset

InternalWalletAssetAdded

ParameterTypeDescription
typestringINTERNAL_WALLET_ASSET_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataWalletAssetWebhookInternal wallet details

ExternalWalletAssetAdded

ParameterTypeDescription
typestringEXTERNAL_WALLET_ASSET_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataWalletAssetWebhookExternal wallet details

ExchangeAccountAdded

ParameterTypeDescription
typestringEXCHANGE_ACCOUNT_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataThirdPartyWebhookExchange accounts details

FiatAccountAdded

ParameterTypeDescription
typestringFIAT_ACCOUNT_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataThirdPartyWebhookFiat account details

NetworkConnectionAdded

ParameterTypeDescription
typestringNETWORK_CONNECTION_ADDED
tenantIdstringUnique id of your Fireblocks' workspace
timestampnumberTimestamp in milliseconds
dataNetworkConnectionNetwork connection details

Data Objects

WalletAssetWebhook

ParameterTypeDescription
assetIdstringThe wallet's asset
walletIdstringThe ID of the wallet
namestringThe name of wallet
addressstringThe address of the wallet
tagstringFor XRP wallets, the destination tag; for EOS/XLM, the memo; for the fiat providers (Signet by Signature, SEN by Silvergate, or BLINC by BCB Group), the Bank Transfer Description
activationTimestringThe time the wallet will be activated in case wallets activation posponed according to workspace definition

ThirdPartyWebhook

ParameterTypeDescription
idstringId of the thirdparty account on the Fireblocks platform
subTypestringSubtype of the third party, ie. exchange or fiat name
namestringAccount name