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.
Note:
Not all of the parameters will appear on the response. Some of the parameters are optional. If you have any issues, please contact the customer success manager.
Vault account created
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 |
Asset added to vault account
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 |
Asset balance changed
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 changes.
| 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 |