Workflow Control Actions
Run a Workflow
RUN WORKFLOW
What it does: Calls another automation (sub-workflow) and optionally passes inputs. Use to reuse shared logic or chain workflows.
Inputs
- Workflow (required) — Which automation to run (dropdown or variable with workflow ID/name).
- Input values (required if the target has a manual trigger) — Map of input name → value. Keys must match the target workflow’s trigger inputs; values can be variables from the current workflow.
Outputs
The run ID and status, and optionally the outputs of the called workflow’s steps (if the product exposes them).
Output schema
- workflowRunId — ID of the executed run. Use for “Wait for workflow runs” or logging.
- status — Run status (e.g. completed, failed, running).
- outputs (optional) — If the product returns sub-workflow outputs: object with step names or output keys and their values (e.g.
#RunWorkflow.outputs.StepName.field).
Wait for a Workflow Run to Complete
WAIT FOR WORKFLOW RUNS TO COMPLETE
What it does: Waits for one or more workflow runs (e.g. started by RUN WORKFLOW) to finish, then aggregates their results. Use for parallel runs and batch processing.
Inputs
- Workflow Runs (required) — List of workflow run IDs to wait for (e.g. from multiple RUN WORKFLOW steps or a variable containing run IDs). Usually an array variable.
- Error handling (optional) — What to do if one or more runs fail: fail this step, or continue and report failed count. Product-dependent.
- Output schema for aggregation (optional) — How to combine outputs (e.g. collect all
resultfields into an array). Product-dependent.
Outputs
Aggregated results from all runs, plus counts and overall status. Use for “all done” logic or to merge results into one list.
Output schema
- results (array) — Aggregated outputs from each run (e.g. list of each run’s result object). Structure depends on aggregation config.
- completedCount — Number of runs that completed successfully.
- failedCount — Number of runs that failed.
- status — Overall status: completed, partial (some failed), or failed.
Conditional Paths
PATHS
What it does: Conditional branching—runs one of several paths based on a condition. Use for “if X then A else B” or multi-way routing (e.g. by deal stage, by email type).
Inputs
- Condition (required) — The rule that decides which path runs. Can be: a single expression (e.g.
#Trigger.amount > 1000), or multiple branch rules (e.g. “If status = New → Path 1; If status = Won → Path 2; Else → Default path”). Depends on product (dropdown, formula, or visual builder). - Paths — Each path is a named branch with its own steps. You add steps inside each path; only the path whose condition matches runs.
Outputs
The output of whichever path executed. Structure matches that path’s last step or a defined “path output” if the product supports it.
Output schema
- output — The return value of the branch that ran. Fields depend on the steps inside that path. Use variable picker after the PATHS step to see the shape (e.g.
#PathsStep.output.result).
Iterators
ITERATOR
What it does: Runs a set of nested steps once per item in a list. Use to process each contact, each row, or each search result.
Inputs
- List (required) — The array to iterate over. Usually a variable (e.g.
#SearchStep.results,#Trigger.emails). Can be the output of a previous step that returns an array.
Outputs
Aggregated results from all iterations (e.g. array of each iteration’s output, or a single merged object). Configurable in the step (e.g. “Collect all”, “First only”, “Count”).
Output schema
- results (array) — One item per iteration. Each item is the output of the nested steps for that iteration (e.g.
#Iterator.results[0].summary,#Iterator.results[1].summary). Exact shape depends on what’s inside the iterator. - count (optional) — Number of iterations run.
- currentItem (inside iterator only) — Within nested steps, the current list item (e.g.
#Iterator.currentItem.email). Not in top-level output.
Ending a Workflow
END WORKFLOW
What it does: Stops the current run immediately. Optionally returns a final output or status. Use for early exit after a condition or to return a value to a caller (e.g. RUN WORKFLOW).
Inputs
- Output (optional) — A value to return as the workflow’s result (e.g. object with summary, status). Used when this workflow is called by RUN WORKFLOW.
- Status (optional) — Final status label (e.g. success, cancelled, no_match). Product-dependent.
Outputs
None to downstream steps (run ends). If Output is set, that value is available to the caller (RUN WORKFLOW step) as the workflow result.
Output schema
- No output to same workflow. Caller may receive output / returnValue as defined in the END WORKFLOW configuration.