This page describes all events relating to vault accounts that produce webhook notifications, and their associated data objects.
The type
parameter is automatically set to the description name for the data objects below.
Vault Account Added
Notification is sent when a vault account is created.
Webhook data
Parameter | Type | Description |
---|---|---|
type | string | VAULT_ACCOUNT_ADDED |
tenantId | string | Unique ID of your Fireblocks workspace |
timestamp | number | Timestamp in milliseconds |
data | VaultAccount | Vault Account details |
Vault Account Asset Added
Notification is sent when any asset is added to a vault account.
Webhook data
Parameter | Type | Description |
---|---|---|
type | string | VAULT_ACCOUNT_ASSET_ADDED |
tenantId | string | Unique ID of your Fireblocks workspace |
timestamp | number | Timestamp in milliseconds |
data | AssetAddedData | Vault account and asset details |
AssetAddedData
Parameter | Type | Description |
---|---|---|
accountId | string | The ID of the vault account under which the wallet was added |
accountName | string | The name of the vault account under which the wallet was added |
assetId | string | Wallet's asset |
Vault Asset Balance Updated
In Early Access
This webhook is currently part of an early access program. If you're interested in participating in the program, please contact your Customer Success Manager (requires a Help Center login).
Notification is sent when a vault account's asset balance is updated.
Parameter | Type | Description |
---|---|---|
type | string | VAULT_BALANCE_UPDATE |
tenantId | string | Unique ID of your Fireblocks workspace |
timestamp | number | Timestamp in milliseconds |
data | VaultAssetBalanceUpdate | Vault account details |
Vault Account Added Bulk
Several vault accounts were added to the workspace as a single bulk job.
Vault Wallet Ready Bulk
Asset wallets were added to all specified vault accounts as a bulk job.