Add API Task to a process automation
- Updated: 2025/06/11
You can add an API Task to configure the settings of a 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 name in the Element name field.
-
Enter the task name in the Task display name
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).
- Select an API bot in the Select API Task Bot field.
-
Optional: In the Data privacy tag field, enter
a text or variable to generate hidden custom output. Select the input values
(x) check box.
- Select a source for the Variable Source: Global, Process, or Task.
- For Process or Task sources, select a Variable type: Input, Output, or Meta.
- For all three variable source types, specify your variable in the Variable field.
- Click Add.
-
Click Save.
You have now configured the API Task in your Process Composer process automation.