Automation Anywhere Callbacks

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bots > Automation Anywhere bot integration >

Automation Anywhere Callbacks

From version 11.3.2 of Automation Anywhere Callbacks can be used to retrieve outputs of your bot directly from your bot execution. Bizagi supports callbacks to retrieve outputs directly from the bot without the use of a Metabot.

To use this feature you must create a new endpoint in your Work Portal. This article will explain how to open this end point.


Endpoint format

This endpoint URL must always have the following format:


[Work Portal URL]/api/rpa/automation/callback


Your Work Portal URL is the URL used to access your work portal. Usually it is built using the following pattern


[http or https]://[Machine name]/[Project name]


From now on your endpoint URL must be an exact coincidence at any step of the process to successfully execute the Callback


Automation Anywhere configuration

The first step to configure your Callback integration is to activate it in the Control Room. Follow these steps to activate it:

Log in using an administrator account.

Go to Administration > Settings > CONTROL ROOM DATABASE & SOFTWARE and click Edit.




Scroll down to the Deployment settings and click the big plus icon on the Callback URLs section




Write your Callback URL




Scroll to the top of the window and click Save changes.




Bizagi configuration

Once you have taken care of the Automation Anywhere setup of the robot, head to Bizagi Studio and go to the Expert view.




Click the Bots option and locate the Automation Anywhere branch under RPA bots.




Click Automation Anywhere and then select Add Connection.




At this point, the Automation Anywhere RPA configuration wizard appears. The following list, explains the parameters you need to configure in order to assure a successful connection to your server, which hosts the process you want to trigger from Bizagi.


Display Name: A name for the connection to let you identify it in later steps. It can be any name you want.

Base URL: The URL associated with your Automation Anywhere server along with the port used to established the connection.

Username/e-mail: The username you use to access the server.

Password: Password of the user introduced in the previous field.


Once you are finished filling in the form fields, click Test connection and check that the resulting connection status in the text field below, shows a message indicating a successful connection.




If a message indicating otherwise appears, review the inputted information or your server configuration, and try again.

Once your connection is successful, add your Callback URL and click OK.




With this your end-point and connection are configured


Add new bot

To add a new callback bot go to you must add a new robot since callbacks don't work with queues.

To add this bot go to your connection and click Add bot.




In the new window that appears select your process and a machine from list.




If you select the check  Execute without waiting for an answer Bizagi will not wait for any output.

Click Next >>.


On the next window you must provide a JSON like structure of your inputs and outputs. Each input and output must be represented as a key-value pair inside the .

Bizagi supports the following Automation Anywhere types of inputs and outputs

Text: To identify it follow this format

 "[Name]": "String"  

List:  To identify it follow this format

 "[Name]": "[]"  



Bizagi cannot use Object or Lists of Objects in the outputs or inputs


Your JSON should look something like this




Click Next >>. A summary window will appear check that all the information is correct and click Finish.




With this your bot is configured and we must add it to a process.


Add the bot to a process

The Automation Anywhere robot can only be called from a Bot Task so your process must have one.

Configure the task that the bot executes on your model, by changing its type to a Bot Task.




A bot task is identified by the UIPath-bot00 icon.




Then go to the Sixth step of the Wizard Define Integration Interfaces (Optional), to configure the execution.




Click the task you just converted to a Bot Task, to launch the RPA Execution Configuration Wizard.




The RPA Execution Configuration Wizard appears.




In this Wizard you can configure the triggering of an RPA bot when your process reaches this point on its flow. First, select the corresponding RPA vendor on the left panel, in this case click Automation Anywhere.

After you select your vendor, you can see on the main panel the list of available bot configurations. This list corresponds to what you have previously configured on the Expert View. Select the robot that you want to use at this point of your process.

In a Automation Anywhere Bot you don't need to configure any runtime parameters.




Once you are done providing this information, click Next. If your bot receives parameters, you will see a mapping interface in which you can select which attribute of your data model is going to be used as a parameter by the bot. You will be prompted to map in which attribute of your data model the resulting information from the bot is going to be stored.


If you configured the process in the Expert View, indicating that it does not receive any parameters, these steps are automatically skipped.

Otherwise map the inputs to your data model an click Next. To map a collection to a list map both the collection and the input attribute.




Again map your outputs to your Data Model and click Next. Again to obtain the values of a list map it to both the collection and its parameter.




Click Finish.


At this stage, you configured your task successfully, but your end-point has no authorized access, you need to set some security settings to use your bot.


Security configuration

To allow access to the Callback end-point in Bizagi you must create an authorized group of users that can use this service. This must be done at the individual process level.

Follow these steps to configure your security access for each process.

Go to the Expert view and in the Security tab and navigate to Authorization > RPA > Callbacks.




Here find your process that uses Callbacks.




Add either a User group, Role or Stakeholder authorized to access the process.




Select the Allow option and click OK.

This new user is now authorized to work on the case but the Callback needs an RPA token generated by this user.


RPA Token

Log into your work portal as an user with rights to create OAuth Tokens. Go to Admin > Secirity > OAuth 2 Application.




In the new panel click the plus icon to add a new application.




Give it a Name and select the Grant type as Client Credentials.




Check the API and RPA Scopes.




In the field User Name, select one of the users previously authorized by its Group, Role or Stakeholder, and add a Description.




Finally, click Save. at this point your Bot using callbacks is ready to run.