Documentation

Webhooks

webhooks

Methods

->
get

Domain types

BridgeCryptoDepositMetadata = { drain_id, liquidation_address, liquidation_address_id, 3 more... }

Bridge metadata for a crypto deposit via liquidation address.

BridgeCryptoTransferMetadata = { method, source_wallet_address, transfer_id, 1 more... }

Bridge metadata for a crypto deposit via transfer.

BridgeFiatDepositMetadata = { activity_id, method, type, 1 more... }

Bridge metadata for a fiat deposit via virtual account.

BridgeFiatTransferMetadata = { method, transfer_id, type }

Bridge metadata for a fiat deposit via transfer.

BridgeMetadata =
BridgeCryptoDepositMetadata
|
BridgeRefundMetadata
|
BridgeFiatDepositMetadata
| 4 more...

Metadata about a Bridge transaction associated with a wallet event.

BridgeRefundMetadata = { drain_id, liquidation_address_id, method, 2 more... }

Bridge metadata for a refund via liquidation address.

BridgeStaticMemoDepositMetadata = { method, static_memo_event_id, static_memo_id, 1 more... }

Bridge metadata for a fiat deposit via static memo.

BridgeTransferRefundMetadata = { method, transfer_id, type, 1 more... }

Bridge metadata for a transfer refund.

FundsDepositedWebhookPayload = { amount, asset, block, 9 more... }

Payload for the wallet.funds_deposited webhook event.

FundsWithdrawnWebhookPayload = { amount, asset, block, 8 more... }

Payload for the wallet.funds_withdrawn webhook event.

IntentAuthorizedWebhookPayload = { authorized_at, created_at, expires_at, 7 more... }

Payload for the intent.authorized webhook event.

IntentCreatedWebhookPayload = { created_at, expires_at, intent_id, 6 more... }

Payload for the intent.created webhook event.

IntentExecutedWebhookPayload = { action_result, created_at, expires_at, 6 more... }

Payload for the intent.executed webhook event.

IntentFailedWebhookPayload = { action_result, created_at, expires_at, 6 more... }

Payload for the intent.failed webhook event.

IntentRejectedWebhookPayload = { created_at, expires_at, intent_id, 6 more... }

Payload for the intent.rejected webhook event.

KrakenEmbedCustomOrderCancelledWebhookPayload = { cancelled_at, custom_order_id, reason, 2 more... }

Payload for the kraken_embed.custom_order.cancelled webhook event.

KrakenEmbedCustomOrderExecutedWebhookPayload = { custom_order_id, executed_at, type, 1 more... }

Payload for the kraken_embed.custom_order.executed webhook event.

KrakenEmbedCustomOrderExecutionFailedWebhookPayload = { custom_order_id, failed_at, reason, 2 more... }

Payload for the kraken_embed.custom_order.execution_failed webhook event.

KrakenEmbedQuoteCancelledWebhookPayload = { cancelled_at, quote_id, reason, 2 more... }

Payload for the kraken_embed.quote.cancelled webhook event.

KrakenEmbedQuoteExecutedWebhookPayload = { executed_at, quote_id, type, 1 more... }

Payload for the kraken_embed.quote_executed webhook event.

KrakenEmbedQuoteExecutionFailedWebhookPayload = { failed_at, quote_id, reason, 2 more... }

Payload for the kraken_embed.quote.execution_failed webhook event.

KrakenEmbedUserClosedWebhookPayload = { closed_at, type, user_id }

Payload for the kraken_embed.user.closed webhook event.

KrakenEmbedUserDisabledWebhookPayload = { disabled_at, type, user_id }

Payload for the kraken_embed.user.disabled webhook event.

KrakenEmbedUserVerifiedWebhookPayload = { type, user_id, verified_at }

Payload for the kraken_embed.user.verified webhook event.

MfaDisabledWebhookPayload = { method, type, user_id }

Payload for the mfa.disabled webhook event.

MfaEnabledWebhookPayload = { method, type, user_id }

Payload for the mfa.enabled webhook event.

PrivateKeyExportWebhookPayload = { type, user_id, wallet_address, 2 more... }

Payload for the wallet.private_key_export webhook event.

SeedPhraseExportWebhookPayload = { type, user_id, wallet_address, 2 more... }

Payload for the wallet.seed_phrase_export webhook event.

TransactionBroadcastedWebhookPayload = { caip2, transaction_hash, transaction_id, 3 more... }

Payload for the transaction.broadcasted webhook event.

TransactionConfirmedWebhookPayload = { caip2, transaction_hash, transaction_id, 3 more... }

Payload for the transaction.confirmed webhook event.

TransactionExecutionRevertedWebhookPayload = { caip2, transaction_hash, transaction_id, 3 more... }

Payload for the transaction.execution_reverted webhook event.

TransactionFailedWebhookPayload = { caip2, transaction_hash, transaction_id, 3 more... }

Payload for the transaction.failed webhook event.

TransactionProviderErrorWebhookPayload = { caip2, transaction_hash, transaction_id, 3 more... }

Payload for the transaction.provider_error webhook event.

TransactionReplacedWebhookPayload = { caip2, transaction_hash, transaction_id, 3 more... }

Payload for the transaction.replaced webhook event.

TransactionStillPendingWebhookPayload = { caip2, transaction_hash, transaction_id, 4 more... }

Payload for the transaction.still_pending webhook event.

UnsafeUnwrapWebhookEvent =
IntentAuthorizedWebhookPayload
|
IntentCreatedWebhookPayload
|
IntentExecutedWebhookPayload
| 47 more...

Payload for the intent.authorized webhook event.

UserAuthenticatedWebhookPayload = { account, type, user }

Payload for the user.authenticated webhook event.

UserCreatedWebhookPayload = { type, user }

Payload for the user.created webhook event.

UserLinkedAccountWebhookPayload = { account, type, user }

Payload for the user.linked_account webhook event.

UserOperationCompletedWebhookPayload = { actual_gas_cost, actual_gas_used, block_number, 9 more... }

Payload for the user_operation.completed webhook event.

UserTransferredAccountWebhookPayload = { account, deletedUser, fromUser, 2 more... }

Payload for the user.transferred_account webhook event.

UserUnlinkedAccountWebhookPayload = { account, type, user }

Payload for the user.unlinked_account webhook event.

UserUpdatedAccountWebhookPayload = { account, type, user }

Payload for the user.updated_account webhook event.

UserWalletCreatedWebhookPayload = { type, user, wallet }

Payload for the user.wallet_created webhook event.

WalletActionEarnDepositCreatedWebhookPayload = { action_type, asset_address, caip2, 10 more... }

Payload for the wallet_action.earn_deposit.created webhook event.

WalletActionEarnDepositFailedWebhookPayload = { action_type, asset_address, caip2, 12 more... }

Payload for the wallet_action.earn_deposit.failed webhook event.

WalletActionEarnDepositRejectedWebhookPayload = { action_type, asset_address, caip2, 12 more... }

Payload for the wallet_action.earn_deposit.rejected webhook event.

WalletActionEarnDepositSucceededWebhookPayload = { action_type, asset_address, caip2, 12 more... }

Payload for the wallet_action.earn_deposit.succeeded webhook event.

WalletActionEarnIncentiveClaimCreatedWebhookPayload = { action_type, chain, rewards, 4 more... }

Payload for the wallet_action.earn_incentive_claim.created webhook event.

WalletActionEarnIncentiveClaimFailedWebhookPayload = { action_type, chain, failure_reason, 6 more... }

Payload for the wallet_action.earn_incentive_claim.failed webhook event.

WalletActionEarnIncentiveClaimRejectedWebhookPayload = { action_type, chain, failure_reason, 6 more... }

Payload for the wallet_action.earn_incentive_claim.rejected webhook event.

WalletActionEarnIncentiveClaimSucceededWebhookPayload = { action_type, chain, rewards, 5 more... }

Payload for the wallet_action.earn_incentive_claim.succeeded webhook event.

WalletActionEarnWithdrawCreatedWebhookPayload = { action_type, asset_address, caip2, 10 more... }

Payload for the wallet_action.earn_withdraw.created webhook event.

WalletActionEarnWithdrawFailedWebhookPayload = { action_type, asset_address, caip2, 12 more... }

Payload for the wallet_action.earn_withdraw.failed webhook event.

WalletActionEarnWithdrawRejectedWebhookPayload = { action_type, asset_address, caip2, 12 more... }

Payload for the wallet_action.earn_withdraw.rejected webhook event.

WalletActionEarnWithdrawSucceededWebhookPayload = { action_type, asset_address, caip2, 12 more... }

Payload for the wallet_action.earn_withdraw.succeeded webhook event.

WalletActionSwapCreatedWebhookPayload = { action_type, caip2, input_amount, 6 more... }

Payload for the wallet_action.swap.created webhook event.

WalletActionSwapFailedWebhookPayload = { action_type, caip2, failure_reason, 8 more... }

Payload for the wallet_action.swap.failed webhook event.

WalletActionSwapRejectedWebhookPayload = { action_type, caip2, failure_reason, 8 more... }

Payload for the wallet_action.swap.rejected webhook event.

WalletActionSwapSucceededWebhookPayload = { action_type, caip2, input_amount, 8 more... }

Payload for the wallet_action.swap.succeeded webhook event.

WalletActionTransferCreatedWebhookPayload = { action_type, destination_address, source_chain, 8 more... }

Payload for the wallet_action.transfer.created webhook event.

WalletActionTransferFailedWebhookPayload = { action_type, destination_address, failure_reason, 10 more... }

Payload for the wallet_action.transfer.failed webhook event.

WalletActionTransferRejectedWebhookPayload = { action_type, destination_address, failure_reason, 10 more... }

Payload for the wallet_action.transfer.rejected webhook event.

WalletActionTransferSucceededWebhookPayload = { action_type, destination_address, source_chain, 9 more... }

Payload for the wallet_action.transfer.succeeded webhook event.

WalletFundsAsset =
WalletFundsNativeTokenAsset
|
WalletFundsErc20Asset
|
WalletFundsSplAsset
| 1 more...

An asset involved in a wallet transfer.

WalletFundsErc20Asset = { address, type }

An ERC-20 token asset.

WalletFundsNativeTokenAsset = { address, type }

A native token asset (e.g. ETH, SOL).

WalletFundsSacAsset = { address, type }

A Stellar Asset Contract (SAC) asset.

WalletFundsSplAsset = { mint, type }

A Solana SPL token asset.

WalletRecoveredWebhookPayload = { type, user_id, wallet_address, 1 more... }

Payload for the wallet.recovered webhook event.

WalletRecoverySetupWebhookPayload = { method, type, user_id, 2 more... }

Payload for the wallet.recovery_setup webhook event.

WebhookPayload =
UserCreatedWebhookPayload
|
UserAuthenticatedWebhookPayload
|
UserLinkedAccountWebhookPayload
| 48 more...

Union of all webhook payload schemas.

YieldClaimConfirmedWebhookPayload = { caip2, rewards, transaction_id, 2 more... }

Payload for the yield.claim.confirmed webhook event.

YieldDepositConfirmedWebhookPayload = { assets, caip2, owner, 4 more... }

Payload for the yield.deposit.confirmed webhook event.

YieldWithdrawConfirmedWebhookPayload = { assets, caip2, owner, 5 more... }

Payload for the yield.withdraw.confirmed webhook event.