Webhook Data Response Structure

This document describes the structure of the webhook data response payload. The payload is typically sent via an HTTP POST request to a configured webhook endpoint.

📘 Unified Webhook Structure

1. Watchlist Trader Alert

{
  "type": "TRADER",
  "name": "WH - Watchlist",
  "webhookUrl": "https://webhook.site/587b89ca-ea4b-4742-9993-6fc040e8dc72",
  "data": {
    "id": "6801bed617b6efe92ce65d15",
    "account": "0x3893209E93c68E7457ef722A4D974861F92859E8",
    "type": "OPEN",
    "isLong": true,
    "leverage": "2.0x",
    "token": "ETH",
    "volume": 9.9887,
    "price": 1587.5997,
    "positionId": "6801bed617b6efe92ce65d2a",
    "protocol": "GMX_V2",
    "time": "2025-04-18T02:54:09.000Z"
  },
  "timestamp": "2025-04-18T02:54:15.155Z"
}

2. Custom Trader Alert

{
  "type": "CUSTOM",
  "name": "WH - Custom Trader",
  "webhookUrl": "https://webhook.site/587b89ca-ea4b-4742-9993-6fc040e8dc72",
  "data": {
    "id": "6801c3a117b6efe92ce90c0e",
    "account": "0x3893209E93c68E7457ef722A4D974861F92859E8",
    "type": "OPEN",
    "isLong": true,
    "leverage": "2.0x",
    "token": "BTC",
    "volume": 9.9928,
    "price": 84820.9382,
    "positionId": "6801c3a117b6efe92ce90c17",
    "protocol": "GMX_V2",
    "time": "2025-04-18T03:14:36.000Z"
  },
  "timestamp": "2025-04-18T03:14:45.085Z"
}

3. Copy Trader Alert

{
  "type": "COPY_TRADE",
  "name": "Cold face",
  "webhookUrl": "https://webhook.site/587b89ca-ea4b-4742-9993-6fc040e8dc72",
  "data": {
    "activityLogId": "6801bedb2fa5dc9ca2d91268",
    "type": "OPEN",
    "token": "ETH",
    "account": "0x3893209E93c68E7457ef722A4D974861F92859E8",
    "isLong": true,
    "isReverse": false,
    "walletName": "Default 0x26C",
    "exchange": "HYPERLIQUID",
    "leverage": "2.00",
    "volume": 19.97,
    "price": "1,585.10",
    "isSuccess": true,
    "copyTradeTitle": "Cold face",
    "pnl": 0,
    "roi": 0,
    "userRef": "45657657567657567657",
    "protocol": "GMX_V2"
  },
  "timestamp": "2025-04-18T02:54:30.029Z"
}

---

I. Root-Level Fields

Field Name	Type	Description	Applies To
type	string	TRADER – Track manual trader activity CUSTOM – Triggered when trader matches custom filters COPY_TRADE – Auto-executed trades copied from a trader	All
name	string	Name of the alert group or custom label	All
webhookUrl	string	Webhook delivery URL	All
data	object	Payload containing full trade information	All
timestamp	string	When the webhook was sent (ISO 8601, UTC)	All

II. Data Object Fields

Field Name	Type	Description	Applies To
id	string	Unique ID for the trader action	TRADER, CUSTOM
activityLogId	string	Unique ID for copytrade log	COPY_TRADE
account	string	Trader's address	All
type	string	OPEN: Opened a new position INCREASE: Added more volume to current trade DECREASE: Reduced partial volume MODIFY: Modified position CLOSE: Closed the position entirely	All
isLong	boolean	true = Long false = Short	All
leverage	string	Leverage used in the trade	All
token	string	Token being traded	All
volume	number	Trade size	All
price	number/string	Executed price	All
positionId	string	Position ID linked to this trade	TRADER, CUSTOM
protocol	string	Trading protocol/platform used	All
time	string	Trade execution time (ISO 8601, UTC)	TRADER, CUSTOM
exchange	string	Name of the exchange	COPY_TRADE
walletName	string	Name of the user’s wallet used in copytrade	COPY_TRADE
isReverse	boolean	Whether the copy is in reverse mode	COPY_TRADE
isSuccess	boolean	Whether the copy trade was successfully executed	COPY_TRADE
errorMsg	string	Error message (if copy trade failed)	COPY_TRADE(on fail)
copyTradeTitle	string	Campaign title for copy trade	COPY_TRADE
userRef	string	User 's reference code	COPY_TRADE
roi	number	Return on investment (decimal: 0.04 = 4%)	COPY_TRADE, TRADER (on CLOSE)
pnl	number	Profit or loss (in token units)	COPY_TRADE, TRADER (on CLOSE)