Skip to main content

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.

Privy emits webhooks for custodial wallet events, enabling your app to stay synchronized with wallet state and transaction lifecycle. Custodial wallets support both balance and transaction webhooks.
Webhooks can be tested at no cost in development environments. To enable webhooks in production, upgrade to the Enterprise plan in the Privy Dashboard.

​
Transaction events

You can subscribe to transaction status updates via webhooks. For complete details on transaction webhook events, payloads, and setup, see the transaction event webhooks documentation.

​
Balance events

You can subscribe to balance change events when funds are deposited or withdrawn via webhooks. For complete details on balance webhook events, payloads, and setup, see the balance event webhooks documentation.
If the deposit is an outcome of orchestration via a known provider (e.g. onramp, a refund from a failed offramp attempt, or indirect deposit from another crypto wallet), the wallet.funds_deposited webhook payload would include an additional bridge_metadata field with orchestration details:
{
  "event": "wallet.funds_deposited",
  "data": {
    "amount": "2340000",
    "asset": {
      "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "type": "erc20"
    },
    "bridge_metadata": {
      "activity_id": "dbd8b3ce-b7cc-4bc9-8e99-adf8defbb25d",
      "method": "virtual_account",
      "type": "fiat_deposit",
      "virtual_account_id": "bf187db1-1bd5-4716-81d3-e51b01e3637d"
    }
  }
  ...
}

​
Next steps

Transaction event webhooks

Complete guide to transaction lifecycle webhooks

Funding

Complete guide to using Bridge to onramp and offramp funds from your Privy custodial wallets

Balance event webhooks

Complete guide to balance change webhooks