Articles on: Signals and Automation

Webhook Signals: Webhook Builder


Introduction


Building effective webhook signals is essential for seamless integration and automation when trading with a webhook bot.


The Webhook Builder streamlines the process of creating and customizing webhook signals for your trading bot. By following a few simple steps, you can configure your bot to handle signals efficiently and accurately. This tool is designed to make automation straightforward, ensuring your trading operations run smoothly and effectively.


Using the Webhook Builder


  1. In the Webhook bot's details, click on Webhook Builder. Then, enter the bot's API secret, into the empty field.


Optional:


To enable the webhook builder to remember the bot's API secret, click the "remember" button as shown below, after the API secret has been entered into the empty field.


Click "remember" to allow the webhook builder to remember the bot's API secret

A warning will be shown (see below) after clicking "remember", stating that the secret will be stored in the browser or desktop app. Once the browser or desktop app is closed, the secret will no longer be remembered.


Risk warning regarding storage of the bot's API secret

  1. Select the trading pair that the signal is to be sent to.


Only trading pairs that exist on the exchange that is set up on the bot, will be shown in this list.


  1. Next, choose the Webhook Action (i.e. type of signal) for the payload


There are 5 different webhook actions available:


  • Open


An Open signal is used to open a new position. More details are available on the following link: Open Signal


  • Increase


The Increase signal is used to increase the position size of one or more open positions, for a single market and side. More details are available on the following link: Increase Signal


  • Reduce


The reduce signal is used to reduce the position size of one or more positions opened by the signal bot, for the specified market and side. More details are available on the following link: Reduce Signal


  • Close


The Close signal is used to close running position/s for the specified market, that were opened by the same Signal Bot. More details are available on the following link: Close Signal


  • Reverse


The Reverse signal can only be used for Futures markets. It is used for closing the existing position(s) with a Market order and opening a new position with the given parameters. More details are available on the following link: Reverse Signal


Settings related to price and order size will change, based on the type of webhook action selected. e.g. for a Close action, there is no order size selection and only a price can be specified.


  1. Next select the Side for the position (Long/buy entry; or short/sell entry) and select the Order Type (i.e. Market, Limit).
  2. For a Limit order, enter the price, as shown below.


  1. Specify the order size in Quote or Base, then enter the order size, into the empty field.


If the order size field is left empty and the generated payload is sent to the bot, the bot's settings will be used to determine the size


There are 3 options for determining order size, some of which only apply to certain webhook actions:


  • Quote


A fixed amount in quote currency can be entered within this field. For the pair BTC/USDT, USDT is the quote currency.


  • Base


A fixed amount in base currency can be entered within this field. For the pair BTC/USDT, BTC is the base currency.


  • Percentage (only applies to Increase and Reduce actions)


Percentage field for determining order size for Increase and Reduce actions

A percentage can be entered within the field shown above, after clicking the % sign. The percentage entered, is based on a percentage of the current open position size.


For an Increase or Reduce signal, the order size must be specified. If omitted, the order will fail, as it will be placed for an amount of 0.


  1. Next, click Copy Payload, to copy the webhook message to the clipboard.


If additional settings are needed, refer to the relevant section in Webhook Signals: Open, Increase, Reduce, Close or Reverse a Position to learn how to edit the webhook message accordingly.


  1. Finally, access the testing page (i.e. Swagger) from here.


1. This is where the webhook message can be pasted for testing.

2. To send a signal to the webhook bot, based on the pasted webhook message, click this button.


If the webhook message is not edited to include "test": true — a signal that creates an Open order, will be sent to the relevant webhook bot. Note that "test": true ONLY works with Open signals.


To learn more about testing webhook signals via Swagger, refer to the following article: Webhook Signals: Testing and Errors



Learn about how webhook signals work, starting here: Webhook and Trading View Signals: Overview

More about the settings used in the Webhook message: Webhook Signals: Open, Increase, Reduce, Close or Reverse a Position

How to send a webhook signal using an Altrady alert

Updated on: 20/06/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!