This page describes all events relating to wallet webhooks that produce webhook notifications, and their associated data objects for webhooks v2.
Note:
Both webhooks v1 and v2 still working as expected but we are highly recommend you to use webhooks v2. Please refer to the each table to see the details of object structure.
Vault Account Added
Notification is sent when a vault account is created.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | vault_account.created. |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | VaultAccount | Object containing data associated with the event. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
Vault Account Asset Added
Notification is sent when any asset is added to a vault account.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | vault_account.asset.added. |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | AssetAddedData | Object containing data associated with the event. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
Vault Asset Balance Updated
Notification is sent when a vault account's asset balance is updated.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | vault_account.asset.balance_updated |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | VaultAssetBalanceUpdate | Object containing data associated with the event. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |