Webhook API Reference

Technical reference for the JSON alert signal accepted by the webhook endpoint.

Required Fields

Field	Type	Description
auth_key	string	Your unique webhook authentication key.
ticker	string	Trading symbol (e.g., “AAPL”).
direction	string	long (Buy) or short (Sell).
marketPrice	number	Current price for slippage calculations.

Optional Fields

Field	Type	Default	Description
qty	number	1	Shares/contracts quantity.
orderType	string	market	market, limit, stop, stop_limit.
limitPrice	number	-	Required for limit and stop_limit.
stopPrice	number	-	Required for stop and stop_limit.

Examples

Market Order (Standard)

{
  "auth_key": "YOUR_AUTH_KEY",
  "ticker": "AAPL",
  "positionDirection": "entryLong",
  "orderType": "market",
  "qty": 100,
  "marketPrice": 150.50,
  "metadata": {
    "timestamp": "2024-11-25T14:30:00.000Z",
    "strategy": "MA Crossover",
    "signal": "Golden Cross"
  }
}

Stop-Limit Order

{
  "auth_key": "YOUR_AUTH_KEY",
  "ticker": "SPY",
  "positionDirection": "entryLong",
  "orderType": "stop_limit",
  "qty": 100,
  "marketPrice": 420.25,
  "stopPrice": 420.00,
  "limitPrice": 421.00,
  "metadata": {
    "timestamp": "2024-11-25T14:30:45.000Z",
    "strategy": "Breakout Entry",
    "signal": "Volume Spike"
  }
}