Webhook Events Documentation

This document details all webhook events sent by the system, including their payloads and metadata.

Account Events

account.created

Triggered when a new account is created in the system.

Payload:

{
  "account_id": "string", // Unique identifier for the account
  "account_name": "string", // Name of the account
  "account_value": "number", // Initial value of the account
  "assets": "array", // List of assets in the account
  "portfolio": "object", // Portfolio details
  "created_at": "string" // ISO timestamp of creation time
}

Metadata:

{
  "user_id": "string", // User who created the account
  "account_id": "string" // ID of the created account
}

account.value.updated

Triggered when an account's value is updated.

Payload:

{
  "account_id": "string", // Unique identifier for the account
  "account_name": "string", // Name of the account
  "previous_value": "number", // Previous account value
  "new_value": "number", // Updated account value
  "change_amount": "string", // Numeric change in value (formatted to 2 decimal places)
  "change_percentage": "string", // Percentage change (formatted to 2 decimal places)
  "asset_count": "number", // Number of assets in the account
  "updated_at": "string" // ISO timestamp of update time
}

Metadata:

{
  "user_id": "string", // Owner of the account
  "account_id": "string" // ID of the updated account
}

Asset Events

asset.created

Triggered when a new asset is created.

Payload:

{
  "asset_name": "string", // Full name of the asset
  "asset_short_name": "string", // Short name/symbol of the asset
  "chain": "string", // Blockchain network
  "address": "string", // Contract address
  "token_type": "string", // Type of token (e.g., ERC20, ERC721)
  "created_at": "string" // ISO timestamp of creation time
}