Add an API Task to a process automation to interact with external
systems through APIs.
About this task
Use an API Task to interact with external systems through APIs, enabling
seamless integration into your process automation.
Procedure
-
Add the API Task option to the process
automation by dragging the element from the Task panel.
-
From the Task: API Task panel:
-
Enter a unique Element ID field.
-
Enter the task name in the Task name (optional)
field.
The task display name appears in the web interface as a reference.
-
Optional: Select the Hide this task from users
check box.
After task completion, the API Task is not displayed to the user in the web interface.
-
In the Run bot and dependencies using section, you can
select Latest version (default).
-
In the API field, select Choose and select an API task
to run.
-
Review Input values. Values populate after you select
the API task. Map each variable to a value or variable from the current
process.
-
In the Data privacy tag (optional) field, enter a text
value or variable to generate a hidden custom output field used for data
privacy searches. This field is used only as a hidden field that can be
searched for data privacy purposes. Variables are populated at runtime.
-
In the Annotation section, select Add
annotation to add context, assumptions, or references for this step.
-
Click Save.
Results
You have configured the API Task in your Process Composer
process automation.