Trigger Run via Webhook
Before you can use webhooks to trigger TaskBot run on your desktop agent, you need to log in to your agent, as described here: Log in to the Agent.
Generate Webhook Link
Go to your TaskBot builder page, open TaskBot Settings and click on Generate Webhook.
Once generated, you will be able to copy the link and use it to trigger TaskBot run programmatically. You can use this link in third-party applications such as Zapier, Make, Pabbly, etc. The webhook can be triggered with a POST or GET method.
Beware that anyone with this link can trigger TaskBot run on your account. If you ever shared this link with anyone and now want to remove their access, you can either deactivate your webhook link or generate a new one.
Deactivate Webhook Link
Simply toggle Webhook is active option off. If the webhook is not active, it cannot be triggered.
Generate a New Link
To generate a new link, delete your current one by clicking on the trash bin icon and then click on Generate Webhook button again. This action will generate a new link, and the old one will be permanently deleted.
Send Dynamic Data
In a POST request, you can send dynamic data via variables.
Example
Consider your TaskBots has these variables:
To pass dynamic data, add variable names and values as key-value pairs to your request body, as shown below.
For example, if you make your request via Postman (or any other API application), this is how it looks like:
Notes
You do not need to include all variables in your body request. Include only those variables that you need to pass data to.
Sending variable names that do not exist in your TaskBot will throw an error and the TaskBot run won't be initiated. It's important to note that you will still receive status 200 (as long as the agent is responding to the trigger) when triggering the TaskBot via webhook. The run will be recorded as failed in your TaskBot run reports and the corresponding error message will be added to the error details inside the run report (see example below). If desired, you can activate notifications on failed runs (Using Run Reports).
Trigger Webhook within a TaskBot Run
Sometimes you might want to trigger another TaskBot within a TaskBot run. For this, you can use Send HTTP Request building block (see APIs: Send HTTP Request). See example set-up below.
Last updated