Tutorials: Tool Widget: Run Subflow

Required access: Voxtelesys Portal

The Run Subflow widget goes under the Tools Category for the VAST Flow Builder. This widget is used to run another Flow from within the current Flow.

When a Flow is used as a Subflow, execution begins at the Subflow transition on the Start Widget of the Subflow. A Subflow is considered to be part of the parent Flow’s execution, so there are no additional charges for Flow executions when using the Run Subflow widget. All variables set within the Subflow are accessible from the Run Subflow widget in the parent Flow as: <widget name>.<variable>.

*Disclaimer: You will need to have Voice API enabled on your account to do this you will need to open a ticket with support.

Last Updated: 1/7/25

To use the widget simply click and drag it into the builder

Note that naming the widget can help identify it with other tools later on. It is case sensitive, does not accept spaces or dashes

The Run Subflow widget has the following configuration abilities:

Flow (required)

The GUID of the Flow to be run as a Subflow.

Flow Version (required)

The version of the Flow to be run as a Subflow. The value of this setting can either be the GUID of the version to use, or it can be live to always use the current live version of the Subflow.

Parameters

To pass parameters into the Subflow, press Add Parameter and enter the name and value of the parameter to send. These parameters can be accessed from within the Subflow using the variable: flow.parameters.<parameter name>.

The Run Subflow widget has the following transition capabilites:

Completed

Activated when execution of the Subflow is completed.

Failed

Activated when the Subflow is unable to be executed. This can occur when the Subflow or its version has been deleted or if the Subflow is nested within another Subflow.

The Run Subflow widget has the following limitations:

• Subflow cannot be nested within other Subflows.
• When multiple Run Subflow widgets in a Flow refer to the same Subflow, each widget must refer to the same version of that Subflow as well.

Now, you will want to connect the Run Subflow widget as seen to the right.

Adding the Run Subflow widget is completed!

To continue the flow, connect more widgets to the opposite end of the Run Subflow widget.

Now connect more widgets! Click on the links below to view more tutorials:

Voice

• Answer Call
• Collect Input
• Connect Call
• Hang Up Call
• Pause Call
• Record Voicemail
• Say/Play

Messaging

• Send SMS

Tools

• HTTP Reqeust
• VoXML Redirect
• Run Subflow
• Translate Text

Control

• Conditions
• Set Variables
• Unset Variables