This page describes all events relating to whitelist 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.
Internal Wallet Asset Added
Notification is sent when any asset is added to an internal wallet.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | internal_wallet.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 | WalletAssetWebhook | Internal Wallet details. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
Internal Wallet Asset Removed
Notification is sent when any asset is removed from an internal wallet.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | internal_wallet.asset.removed |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | WalletAssetWebhook | Internal Wallet details. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
External Wallet Asset Added
Notification is sent when any asset is added to an external wallet.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | external_wallet.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 | WalletAssetWebhook | External Wallet details. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
External Wallet Asset Removed
Notification is sent when any asset is removed from an external wallet.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | external_wallet.asset.removed |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | WalletAssetWebhook | External Wallet details. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
Contract Wallet Asset Added
Notification is sent when any asset is added to a contract wallet.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | contract_wallet.asset.removed |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | WalletAssetWebhook | Contract Wallet details. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID. |
Contract Wallet Asset Removed
Notification is sent when any asset is removed from a contract wallet.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | contract_wallet.asset.removed |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | WalletAssetWebhook | Contract Wallet details. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |
WalletAssetWebhook
| Parameter | Type | Description |
|---|---|---|
| assetId | string | The wallet's asset |
| walletId | string | The ID of the wallet |
| name | string | The name of the wallet |
| address | string | The address of the wallet |
| tag | string | Destination address tag for Ripple; destination memo for Cosmos, EOS, Luna, Luna Classic, NEM, Stellar, Hedera, & DigitalBits; destination note for Algorand; bank transfer description for fiat providers. |
| activationTime | string | The time the wallet will be activated if wallet activation is postponed according to your workspace definition |