Skip to main content
WEBHOOK
wallet_action.earn_withdraw.created
{
  "type": "wallet_action.earn_withdraw.created",
  "wallet_action_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "wallet_id": "fmfdj6yqly31huorjqzq38zc",
  "action_type": "earn_withdraw",
  "status": "pending",
  "caip2": "eip155:8453",
  "vault_id": "cm7oxq1el000e11o8iwp7d0d0",
  "vault_address": "0x1234567890abcdef1234567890abcdef12345678",
  "asset": "usdc",
  "asset_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "decimals": 6,
  "amount": "1",
  "raw_amount": "1000000"
}

Documentation Index

Fetch the complete documentation index at: https://docs.privy.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Payload for the wallet_action.earn_withdraw.created webhook event.

​
type
enum<string>
required

The type of webhook event.

Available options:
wallet_action.earn_withdraw.created
​
wallet_action_id
string
required

The ID of the wallet action.

​
wallet_id
string
required

The ID of the wallet involved in the action.

​
action_type
enum<string>
required

Type of wallet action

Available options:
swap,
transfer,
earn_deposit,
earn_withdraw,
earn_incentive_claim
​
caip2
string
required

CAIP-2 chain identifier.

​
vault_id
string
required

The vault ID.

​
vault_address
string
required

ERC-4626 vault contract address.

​
asset_address
string
required

Underlying asset token address.

​
raw_amount
string
required

Base-unit amount of asset withdrawn (e.g. "1500000").

​
status
enum<string>
required

The status of the wallet action.

Available options:
pending
​
asset
string

Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in the asset registry.

​
decimals
integer

Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only present when the token is known in the asset registry.

​
amount
string

Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when the token is known in the asset registry.

Response

200

Return a 200 status to indicate that the webhook was received successfully.