Skip to main content

​
core.workflow.execute

Execute a workflow by alias.

​
Inputs

​
workflow_alias
string | null
required
Alias of the subflow to execute. Must be provided.
​
batch_size
integer
Number of subflows to execute in parallel.Default: 32.
​
environment
string | null
Subflow’s target execution environment. This is used to isolate secrets across different environments.If not provided, the subflow’s default environment is used.Default: null.
​
fail_strategy
string
Fail strategy to use when a subflow fails.Default: "isolated".Allowed values: isolated, all.
​
loop_strategy
string
Execution strategy to use for the subflow.Default: "batch".Allowed values: parallel, batch, sequential.
​
timeout
number | null
Maximum number of seconds to wait for the subflow to complete. If not provided, the subflow’s default timeout is used.Default: null.
​
trigger_inputs
any | null
Inputs to pass to the subflow (arbitrary JSON).Default: null.
​
version
integer | null
Version of the subflow definition, if any.Default: null.
​
wait_strategy
string
Wait strategy to use when waiting for subflows to complete. In wait mode, this action will wait for all subflows to complete before returning. Any subflow failures will be reported as an error. In detach mode, this action will return immediately after the subflows are created. A failing subflow will not affect the parent.Default: "detach".Allowed values: wait, detach.

​
Examples

Run a subflow 
- ref: run_subflow
  action: core.workflow.execute
  args:
    workflow_alias: enrich_case
    trigger_inputs:
      case_id: ${{ TRIGGER.case_id }}
      severity: ${{ TRIGGER.severity }}
    wait_strategy: wait
    timeout: 300

​
core.workflow.get_status

Get the status of a workflow execution.

​
Inputs

​
wf_exec_id
string
required
The workflow execution ID to check.

​
Examples

Check an execution 
- ref: launch_subflow
  action: core.workflow.execute
  args:
    workflow_alias: collect_evidence
    trigger_inputs:
      case_id: ${{ TRIGGER.case_id }}
- ref: subflow_status
  action: core.workflow.get_status
  depends_on:
    - launch_subflow
  args:
    wf_exec_id: ${{ ACTIONS.launch_subflow.result.wf_exec_id }}