Whitelist events

This page covers all whitelist (or allowlist) events that can trigger webhook notifications, and their associated data objects for the Webhooks v2 service.

Whitelist event types

To receive a specific event, include its eventType in the webhook's notification object.

Event typeData object returned
internal_wallet.asset.addedWalletAssetWebhook
internal_wallet.asset.removedWalletAssetWebhook
external_wallet.asset.addedWalletAssetWebhook
external_wallet.asset.removedWalletAssetWebhook
contract_wallet.asset.addedWalletAssetWebhook
contract_wallet.asset.removedWalletAssetWebhook

Data objects

WalletAssetWebhook

ParameterTypeDescription
assetIdstringThe wallet's asset
walletIdstringThe ID of the wallet
namestringThe name of the wallet
addressstringThe address of the wallet
tagstringDestination 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.
activationTimestringThe time the wallet will be activated if wallet activation is postponed, according to your workspace definition