Run Workflow

Reference documentation for using the Run Workflow action

Written By Support Channel

Last updated Over 1 year ago

Overview of the Run Workflow action

The Run Workflow action allows you to trigger another workflow/block from within the current workflow. The action allows you to pass in arguments as inputs to the triggered workflow, and enables you to use any outputs the workflow provides.

Purpose	Trigger separate workflows/blocks to run from within your workflow
Parameters	Use Workflow ID A Workflow or a Workflow ID Workflow Inputs
Output	Workflow Outputs

Understanding the Run Workflow action

This action will wait for the triggered workflow to fully complete before continuing with the next step in the current workflow. This ensures that outputs or changes made by the triggered workflow are available to use in the remaining steps of the main workflow.

Use Workflow ID

Choose a workflow selection method:

Unselected : UseWorkflowID = false
Choose a workflow from a dropdown list of the available workflows.
Selected : UseWorkflowID = true
Specify the workflow to trigger by providing the exact Workflow ID

Workflow

Select which workflow the Run Workflow action should trigger.

Workflow Inputs

Use these to supply input arguments for your selected workflow. Workflow input fields appear below the Workflow selection control once a target workflow is selected. Required inputs are suffixed with: (Required).

Working with the Run Workflow action

Workflow inputs and outputs

Inputs

Workflows may take inputs; the Run Workflow action generates any input fields needed for a workflow once the target workflow is selected. The input fields appear in the action configuration panel, directly below the Workflow selection control. Use these generated, workflow input fields to provide inputs to your selected workflow. Required inputs must have an argument provided or the workflow will error.

Note

Input fields for a target workflow appear in the configuration panel after you select the workflow that you want to be triggered by the Run Workflow action.

Outputs

You can use the outputs from a workflow triggered by your Run Workflow action. You access them via the action outputs of your Run Workflow action, using the Tag Control. Outputs of a triggered workflow are only available downstream of their associated Run Workflow action.

Create and manage Run Workflow actions

Add a Run Workflow action

Add the action

Use the following steps to add the action to your workflow.

How to add an action to a workflow

Click the ‘plus’ symbol on the workflow path at the point you want to insert the action. This opens the action menu slide-over.
Either:
- Search for the action using the Search field above the actions in the menu.
- Locate a Recently Used action in the top section of the menu.
- Navigate to the action within the menu: Core actions are listed under Actions, while Plugin actions are contained within their associated integration.
Select the desired action to insert it. This reveals the action’s configuration panel.
Use the Name field to name the action. This helps users to understand your workflow at a glance. (optional)
Use the Description field to add information describing the action. This helps users wanting to understand how your workflow functions. (optional)

Configure the action

Use the following steps to configure the action.

Set values for the Use Workflow ID and either Workflow or Workflow ID, depending on your chosen workflow selection method.
Set values for the workflow inputs. Inputs marked (Required) must be populated.
Click back in the main view to hide the slide-over.

Delete a Run Workflow action

Use the following steps to remove the action from your workflow:

How to remove an action from a workflow

Access the workflow in draft mode to edit it.
Either:
- hover your mouse cursor over the action, and then click the red cross that appears over the top-right corner of the action to delete it. Or:
- click on the action to open the action slide-over. Click the red 'Delete Step’ button to remove the action from your workflow.
Click Publish in the top-right to commit your changes.

Take care when deleting an action to also remove any logic using its outputs: workflow steps may function incorrectly or break if they attempt to evaluate an output of a deleted action.

Was this helpful?

Still need help? Share an idea