Webhook Reference | Documentation

Receive trading signal to execute on TradersPost.

POST https://webhooks.traderspost.io/trading/webhook/{uuid}/{password}

Path parameters

uuid string · uuidrequired

Your unique webhook identifier, we call the uuid. Provided when you copy the entire webhook URL from your strategy dashboard.

password string required

Your webhook password. Provided when you copy the entire webhook URL from your strategy dashboard.

Responses

200 Successfully received webhook. application/json

successbooleanrequired

idstringrequired

logIdstringrequired

payloadobjectrequired

Echoes the accepted payload: a single object for a single-payload request, or an array of objects for a batch request.

400 Bad Request - The JSON that gets sent to TradersPost has to be precisely accurate in order for us to accept it. It is important to pay attention to all the details, all the little characters have meaning and are important. application/json

successbooleanrequired

logIdstringoptional

Optional log identifier for tracking the request. May not be present for certain types of errors (e.g., authentication failures, malformed requests).

messageCodestring · enumrequired

Specific error code indicating the type of validation error encountered.

Possible values:

post-requiredempty-jsonmalformed-jsoninvalid-payloadtoo-many-payload-itemsbatch-signals-not-enabledinvalid-actioninvalid-sentimentinvalid-sentiment-actioninvalid-order-typeinvalid-trailing-stopinvalid-option-typeinvalid-intrinsic-valueinvalid-expirationinvalid-strike-countinvalid-strikes-awayinvalid-strike-pricenot-trading-viewnot-trend-spiderinvalid-ip-addressinvalid-ip-address-formatticker-does-not-existinvalid-ticker-and-option-typeinvalid-passwordempty-ticker-nameunsupported-tickerinvalid-quantity-typeinvalid-quantity-type-actioninvalid-risk-dollar-amount-actioninvalid-percent-of-position-actionquantity-type-requires-quantityinvalid-quantity-type-for-asset-classinvalid-quantityinvalid-time-in-forceinvalid-extended-hoursinvalid-asset-classinvalid-take-profit-percentinvalid-take-profit-amountinvalid-take-profit-limit-priceinvalid-take-profit-amount-and-percentinvalid-take-profit-relative-and-absoluteinvalid-take-profit-value-requiredinvalid-stop-loss-typeinvalid-stop-loss-percentinvalid-stop-loss-amountinvalid-stop-loss-stop-priceinvalid-stop-loss-limit-priceinvalid-stop-loss-trail-priceinvalid-stop-loss-trail-amountinvalid-stop-loss-trail-percentinvalid-stop-loss-trail-valueinvalid-stop-loss-trail-value-requiredinvalid-stop-loss-amount-and-percentinvalid-stop-loss-relative-and-absoluteinvalid-stop-loss-stop-price-requiredinvalid-stop-loss-value-requiredinvalid-expires-atinvalid-message-lengthinvalid-message-tagsinvalid-delayinvalid-delay-formatinvalid-delay-pastinvalid-delay-exceeds-maxinvalid-delay-missing-timezoneinvalid-cancel-afterinvalid-reject-afterinvalid-stocks-ticker-formatinvalid-options-ticker-formatinvalid-futures-ticker-formatinvalid-crypto-ticker-formatinvalid-breakeven-offsetinvalid-breakeven-order-typeinvalid-market-price-typeinvalid-bid-ask-spread-filter-amount-and-percentinvalid-bid-ask-spread-filter-percentinvalid-take-profit-pnl-amountinvalid-take-profit-pnl-incompatibleinvalid-stop-loss-pnl-amountinvalid-stop-loss-pnl-incompatibleinvalid-stop-loss-pnl-trailinginvalid-risk-percent-actioninvalid-cancel-order-typeinvalid-formula-syntaxinvalid-formula-referenceinvalid-formula-dependencyinvalid-formula-nestedinvalid-formula-runtimeinvalid-formula-lengthinvalid-formula-operatorinvalid-formula-resultinvalid-formula-blacklisted-field

messagestringrequired

Human-readable error message explaining the validation error.

404 Resource not found. application/json

successbooleanrequired

messageCodestringrequired

messagestringrequired

500 Internal server error. Sometimes an HTML response might come back, but it's best just to rely on the 500 status code.

No content

200

{
    "success": true,
    "id": "47462f2d-378c-4bf5-a016-1c1221aa0e62",
    "logId": "a036eff1-b7db-4f15-b5b6-f5e51995ad29"
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "post-required",
    "message": "The HTTP POST method is required for this trade signal."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "empty-json",
    "message": "Your trade signal was empty. Please ensure that your trade signal contains valid JSON data with the necessary trade instructions. TradersPost requires this information to properly process and execute your trade."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "malformed-json",
    "message": "The JSON payload could not be parsed. Please ensure that your JSON is properly formatted and valid."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-payload",
    "message": "The payload is invalid. Both the action and ticker fields are required."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "too-many-payload-items",
    "message": "The payload contains too many items. A webhook request may contain a maximum of 5 payload items."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "batch-signals-not-enabled",
    "message": "This request contains a list of signals, and this strategy does not accept them. Enable \"Allow batch signals\" in the strategy settings, or send one signal per request."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-action",
    "message": "The provided action is invalid. The action field must be one of the following values: buy, sell, exit, reverse, breakeven, cancel, or add."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-sentiment",
    "message": "The provided sentiment value is invalid. The sentiment field must be one of the following values: bullish, bearish, or flat."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-order-type",
    "message": "The provided orderType is invalid. The orderType field must be one of the following values: market, limit, stop, stop_limit, or trailing_stop."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-option-type",
    "message": "The provided optionType is invalid. The optionType field must be one of the following values: both, call, or put."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-quantity-type",
    "message": "The provided quantityType is invalid. The quantityType field must be one of the following values: fixed_quantity, dollar_amount, risk_dollar_amount, risk_percent, percent_of_equity, or percent_of_position."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-quantity",
    "message": "The provided quantity is invalid. The quantity field must be a positive numeric value."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-take-profit-percent",
    "message": "The provided takeProfit.percent is invalid. The takeProfit.percent field must be a positive numeric value representing a relative percentage."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-stop-loss-type",
    "message": "The provided stopLoss.type is invalid. The stopLoss.type field must be one of the following values: stop, stop_limit, or trailing_stop."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "not-trading-view",
    "message": "The trade signal did not come from TradingView. You have your strategy configured to only accept trade signals from TradingView."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-ip-address",
    "message": "The trade signal did not come from one of your configured IP addresses. You have your strategy configured to only accept trade signals from specific IP addresses."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "ticker-does-not-exist",
    "message": "The provided ticker does not exist in the asset class configured for this strategy."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-password",
    "message": "The password in your webhook URL is not correct. You may need to generate a new Webhook URL if you have lost the correct Webhook URL."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "unsupported-ticker",
    "message": "The provided ticker symbol is not allowed on this strategy. The ticker must be one of the supported tickers configured for this strategy or you must have \"Allow any ticker\" checked."
}

{
    "success": false,
    "logId": "bf3b4869-bf85-48cc-a1b3-8e49c77215ae",
    "messageCode": "invalid-asset-class",
    "message": "The asset class of the provided ticker is not supported by this strategy."
}

{
    "success": false,
    "messageCode": "not-found",
    "message": "Webhook not found."
}