Webhook Signals: Webhook Builder
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.
In the Webhook bot's details, click on Webhook Builder. Then, enter your bot's API secret, into the empty field.
Select the trading pair that you want the signal to be sent for.
Note: only trading pairs that exist on the exchange that is set up on the bot, will be shown in this list.
Next, choose the Webhook Action (i.e. type of signal) for the payload that you want to build, and select the Side for it as well.
Note: 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 you'll only be able to specify the price, if you are building a Limit Close payload.
If you want to specify a price for the signal, you can decide to enter this, wirhin Optional Settings.
Choose whether to specify the order size in Quote or Base, then enter the order size, into the empty field.
Note: if you leave the order size field empty and send the generated payload to your bot, your bot settings will be used to determine the size. For an Increase signal, the order size must be specified.
Finally, click Copy Payload to copy it. You can see a preview of the payload, in the box above the copy button.
Next, you can copy the Webhook URL and paste it in your browser. That will then open Swagger, where you can test your webhook signal, as outlined in the following documentation: Webhook Signals: Testing and Errors
Note: if you don't add "test": true into your code when testing, a live order will be opened (as described in the testing article linked above).
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
In the Webhook bot's details, click on Webhook Builder. Then, enter your bot's API secret, into the empty field.
Select the trading pair that you want the signal to be sent for.
Note: only trading pairs that exist on the exchange that is set up on the bot, will be shown in this list.
Next, choose the Webhook Action (i.e. type of signal) for the payload that you want to build, and select the Side for it as well.
Note: 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 you'll only be able to specify the price, if you are building a Limit Close payload.
If you want to specify a price for the signal, you can decide to enter this, wirhin Optional Settings.
Choose whether to specify the order size in Quote or Base, then enter the order size, into the empty field.
Note: if you leave the order size field empty and send the generated payload to your bot, your bot settings will be used to determine the size. For an Increase signal, the order size must be specified.
Finally, click Copy Payload to copy it. You can see a preview of the payload, in the box above the copy button.
Next, you can copy the Webhook URL and paste it in your browser. That will then open Swagger, where you can test your webhook signal, as outlined in the following documentation: Webhook Signals: Testing and Errors
Note: if you don't add "test": true into your code when testing, a live order will be opened (as described in the testing article linked above).
Updated on: 02/12/2024
Thank you!