Configure API Task in process

You can directly configure API Tasks within a process automation.

Prerequisites

An admin prerequisites:
  • You must have admin privileges to add an API Task to the cloud.
  • To facilitate communication between Control Room and cloud devices, a Control Room admin needs to perform the following actions to Generate a registration key to use for bulk bot agent installation:
    • Navigate to Administration > Settings > Bot agent bulk install.
    • click Edit, the Generate a new key option is selected by default.
    • Click Save changes to generate a registration key.
A bot creator prerequisites:

This example delves into sending a Microsoft Teams chat message via API Tasks within your process:

Procedure

  1. Create a new process.
    1. Access the Control Room on your local machine, logging in as a Bot Creator.
    2. Navigate to the left pane and select Automation.
    3. Click Create new > Process.
    4. On the Create process page, provide a descriptive name for the new process.
      Processes are saved in the \Bots\ folder. Click Browse to change the default folder. You can place the process in the same folder as the associated API Task and form for better organization.
    5. Click Create & edit button to proceed.
    API Task in Process
  2. Define a process with an API Task
    1. Drag and drop the API element.
    2. In the Element name field, enter a name. For example: SendMessage.
    3. Enter a Task display name.
    4. Click Browse to locate and select an API Task. Select the API Task created in Create an API Task (API Task in Process).
    The example invokes an API Task that sends a message to Microsoft Teams.