Webhook Reference
Your unique webhook identifier, we call the uuid. Provided when you copy the entire webhook URL from your strategy dashboard.
Your webhook password. Provided when you copy the entire webhook URL from your strategy dashboard.
The ticker symbol of the financial instrument (e.g., AAPL, SPY 250624C596, MNQU2025, BTCUSD).
Note: For futures contracts, continuous symbols like NQ1! are automatically mapped to the front-month contract according to our rollover schedule. Since this schedule may differ from other platforms like TradingView, we strongly recommend using explicit futures contract symbols rather than continuous symbols.
The action or signal type used to determine what type of order to execute.
Note: when you are trading put options, the action is inverted. So this means action=buy will sell to open short puts and action=sell will buy to open long puts. This is necessary when you are running a strategy on the underlying chart but you are buying and selling puts instead of shares.
Optional and often used with TradingView strategies. The expected position sentiment after trade execution:
- bullish - Open position after trade should be bullish or flat
- bearish - Open position after trade should be bearish or flat
- flat - No position should be open after trade execution
The market price at the time your alert is triggered (RECOMMENDED).
For TradingView alerts, you can pass this using the {{close}} placeholder in your alert message.
This value helps calculate slippage - the difference between the alert price and the actual fill price - allowing you to monitor execution quality.
The slippage calculation will fall back to signalPrice, price, limitPrice, or stopPrice in that order.
Optionally send the current market price at the time the signal was generated. This price is used in some cases when a broker does not support fetching quotes or the broker returns an empty quote and is also used to calculate slippage (see the price property).
The type of order to create. If you send an order type not supported by your broker, it will fallback to the default order type configured in the strategy subscription settings.
When orderType=limit or orderType=stop_limit you can send a limitPrice for the order.
- If you omit this value, the current market price will be used when the trade is executed
- This price is also used to calculate slippage (see the
priceproperty)
When orderType=stop or orderType=stop_limit you can send a stopPrice for the order. If you omit this value, the current market price will be used when the trade is executed. This is also used to calculate slippage (see the price property).
For trailing stop orders (orderType=trailing_stop), specifies the fixed dollar amount to trail the market price. The stop price will maintain this absolute dollar offset - for example, with $1.00, it stays $1.00 below the highest price for longs or above the lowest price for shorts. Note: Only one of trailAmount or trailPercent can be used.
For trailing stop orders (orderType=trailing_stop), specifies the percentage to trail the market price. The stop price will maintain this percentage offset from the highest/lowest price reached. Note: Only one of trailAmount or trailPercent can be used.
The type of the value sent in the quantity field. Supported values are:
- fixed_quantity - A fixed quantity number that is used for the order
- dollar_amount - Dynamically calculates a quantity for the given dollar amount
- risk_dollar_amount - Dynamically calculates a quantity for the given risk dollar amount. This type requires a stop loss
- percent_of_equity - Dynamically calculates a quantity for the given percent of equity
- percent_of_position - Dynamically calculates a quantity for the given percent of position Default is fixed_quantity when you send a quantity without a quantityType.
The quantity to enter. If you omit this value, the quantity will be dynamically calculated based on your strategy subscription settings or defaulted to 1.
The time in force for your order. If you send a time in force not supported by your broker, it will fallback to the default time in force or the time in force configured in the strategy subscription settings.
The supported values are:
- day - Good For Day
- gtc - Good Until Canceled
- opg - Market on Open / Limit on Open
- cls - Market on Close / Limit on Close
- ioc - Immediate or Cancel
- fok - Fill or Kill
ISO-8601 timestamp indicating when the signal was generated (e.g. '2024-01-15T14:30:00Z'). When using TradingView, you can use the {{timenow}} placeholder. This timestamp is used to calculate the latency between signal generation and trade execution, which can be viewed in the trade signal logs.
Ignore the defined trading windows in the strategy subscription settings and allow the trade to execute even if it is currently outside of the trading windows.
Explicitly control whether or not to cancel open orders before submitting new orders to your broker.
(STOCKS and OPTIONS SPECIFIC): Whether or not to send the order as an extended hours order. This is only applicable for stocks and the supported values are either true or false.
(OPTIONS SPECIFIC): The type of option contract to trade. The supported values are both, call and put.
(OPTIONS SPECIFIC): The intrinsic value of the option contract to trade. The supported values are itm (in the money) and otm (out of the money).
(OPTIONS SPECIFIC): The expiration of the option contract to trade. The value can be a specific date like 2024-05-06 or a relative date expression like +6 months.
(OPTIONS SPECIFIC): How many strikes to ask for from the broker when executing options trades and scanning the option chain to find a contract to trade.
(OPTIONS SPECIFIC): How many strikes away from at the money to select.
(OPTIONS SPECIFIC): Specifies the strike price of the option contract to trade.
POST /trading/webhook/{uuid}/{password} HTTP/1.1
Host: webhooks.traderspost.io
Content-Type: application/json
Accept: */*
Content-Length: 333
{
"ticker": "AAPL",
"action": "buy",
"sentiment": "long",
"price": 191.25,
"quantity": 10,
"quantityType": "fixed_quantity",
"orderType": "market",
"time": "2025-06-18T14:30:00Z",
"test": true,
"takeProfit": {
"percent": 10
},
"stopLoss": {
"type": "stop",
"percent": 5
},
"extras": {
"strategy": "EMA_Crossover",
"comment": "Breakout entry",
"exitType": "trailing_atr"
}
}{
"success": true,
"id": "47462f2d-378c-4bf5-a016-1c1221aa0e62",
"logId": "a036eff1-b7db-4f15-b5b6-f5e51995ad29",
"payload": {
"ticker": "AAPL",
"action": "buy",
"sentiment": "long",
"price": 191.25,
"quantity": 10,
"quantityType": "fixed_quantity",
"orderType": "market",
"time": "2025-06-18T14:30:00Z",
"test": true,
"takeProfit": {
"percent": 10
},
"stopLoss": {
"type": "stop",
"percent": 5
},
"extras": {
"strategy": "EMA_Crossover",
"comment": "Breakout entry",
"exitType": "trailing_atr"
}
}
}Last updated
Was this helpful?