What is a webhook-link?
A webhook-link is one the ways to launch bots via Orchestrator SaaS. Such a link allows you to start a workflow via an HTTP-request.
How to use it?
One possible scenario for using webhook links is to run a workflow from programs and applications that are not associated with ElectroNeek, but in which you want to integrate the ElectroNeek bot. For example, your company already has a program written in some programming language that solves a specific business problem. If you want to extend the functionality of that program by integrating it with the ElectroNeek bot, using a webhook link will do just that.
How does it work?
You can generate a webhook-link from the bot management page in Orchestrator.
- Publish the created bot in Orchestrator SaaS.
- Make sure that the bot's status is displayed as "Ready".
- Go to the "Webhook link" line in the bot's settings. Click the switch to create such a link.
- Click the "Link" button to copy the webhook link to the clipboard.
To copy the link to the clipboard, click the "Link" button.
Passing parameters into an HTTP request
It is possible to pass any parameters "inside" the bot when using a webhook-link. In Studio Pro there is a variable
webhook_data. This is where the parameters you set will be passed to.
You can use a webhook agent, such as Postman, to pass the parameters you want to the variable.
Example of parameters transferred to the bot through Postman:
Select the "POST" option, copy the webhook link and paste it into the line next to it. In the "Body" section, write down the parameters you want to pass to the variable.
This may look like the workflow in which the parameters will be passed:
Note that the "Value" parameter of the "Input to desktop app" activity uses the "Calculate a value" option and the
webhook_data value is written down in the input field. This is necessary for parameters passed to
webhook_data to be used by this activity.
Thus, the result of this bot's actions in the Notepad will look like this: