Configure a form with API Task in a process

You can add a form that invokes an API Task in a process automation.

Prerequisites

  • You must have a Bot Creator license.
  • You must have created and configured a form with an API Task embedded before adding it into a process. For more details, see Configure an API Task in a form.

Efficiently Integrate API Tasks into Processes for Streamlined Data Retrieval:

This example demonstrates how to leverage the API Task - ZIP code, previously configured within a form (Configure an API Task in a form), within a process automation workflow. For a detailed guide on incorporating forms into your processes, see Add Form Task to a process automation. Notably, invoking an API Task offers significantly lower latency compared to calling a Task Bot. This method allows for flexible creation of process automations that integrate forms with corresponding API Tasks tailored to your specific needs.

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, such as ZIP code 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.
  2. Define Process Start with Initial Form and API Task
    1. Click Start (Process entry) to add an initial form with an embedded API Task. The Start configuration options appear on the right side of the screen.
    2. Click Browse to Select initial data form. For this example, select the API Task - ZIP code form that you previously created in Configure an API Task in a form.
    3. In the Request title field, enter any text. For example: ZIP code details request.
  3. Click Save.