Working with Plural Automation is recommended for users comfortable with API calls and basic scripting. Familiarity with automation tools such as Microsoft Power Automate or Pipedream is helpful.
Create a Plural Automation frame
Click the + symbol
In the upper-left corner of the Plural canvas, click the + symbol to open the frame creation menu.
Select Plural Automation
Choose Plural Automation from the menu. A new, separate frame appears on the canvas alongside your existing Avatar or robot frame.
Communication methods between frames
There are two ways for your Avatar frame and your Automation frame to exchange control and data.Method 1 — IoT Trigger
Add an IoT Trigger element to the Automation frame as its entry point. When your Avatar frame calls the IoT Trigger’s URL (using a Custom API Request element), the Automation frame wakes up, runs its logic, and can return variables back to the Avatar frame.Example: Avatar frame calls an Automation IoT Trigger
In this example, the Automation frame has an IoT Trigger that, when called, sets a variable (answer = "Hello Avatar") and returns it to the Avatar frame.
Get the IoT Trigger URLs and token
Click the IoT Trigger element in the Automation frame to open its sidebar. Copy the Live URL, Test URL, and Auth Token using the sidebar buttons.
Configure the API Call in the Avatar frame
Open the Custom API Request element in your Avatar frame. Paste the IoT Trigger URL as the request URL and set the method to POST.
Add the Authorization header
In the Custom API Request sidebar, go to Header Assignments and add:
- Name:
Authorization - Value:
Token <your_auth_token>
Pass the language parameter (if using Knowledge Base)
Append
?lang=#ATTRI/LanguageISO2 to the URL so the Automation frame knows which language to use:Retrieve the response variable
In the IoT Trigger sidebar of the Automation frame, open the Output tab and check the variable that the automation returns (for example,
answer).In the Custom API Request sidebar of the Avatar frame, click Test Request to inspect the response JSON, then switch to the Attributes tab and map the JSON path to a variable name:- JSON path:
$.answer - Variable name:
automationAnswer
#ATTRI/automationAnswer in any downstream Avatar frame element.
Method 2 — Robot-to-Robot Command
Add a Robot-to-Robot Command element to your Avatar frame and connect its output directly to an element in the Automation frame. This creates a direct in-Plural connection without needing HTTP calls.- Use the Input tab of the Robot-to-Robot Command element to pass a variable from the Avatar frame to the Automation frame.
- Use the Output tab to receive a variable back from the Automation frame into the Avatar frame once the automation completes.
Handling multilingual automation
The only element in an Automation frame that currently requires an explicit language parameter is the Knowledge Base. All other elements are language-agnostic. When calling an Automation frame from a Custom API Request element in your Avatar frame, always include the language suffix on the URL:#ATTRI/LanguageISO2— automatically passes the current project language at runtime.- You can also hard-code a specific language:
?lang=enfor English or?lang=defor German. Use the ISO 639-1 two-letter language code.
Debugging with the IoT Trigger test window
Switch the API call to the Test URL
In your Avatar frame’s Custom API Request element, replace the Live URL with the Test URL from the IoT Trigger sidebar.
Open the test window
In the Automation frame, click the IoT Trigger element and then click Show Test Window.
Trigger the flow
Run your Avatar flow as normal. When the Custom API Request fires, the Test Window displays the full execution log of the Automation frame, including variable values at each step, errors, and API call results.
