Callable Flows

A Callable Flow is a flow designed to be referenced, or called, by another flow.

Callable flows prevent the need to duplicate steps across multiple flows, as multiple flows can reference a single callable flow to repeat common flow actions. You can call a flow using the Call a Flow flow step. For more information see Call a Flow Flow Step.

Callable flows are run independently of the calling flow, and cannot access the same data as the parent flow. The data available to the flow is defined by the trigger's input schema. The data is supplied by the Flow that calls this one. Additionally, flow configurations are scoped to the flow they are on. This means that this flow will not have access to the configuration of the flow that calls it. For more information, see Use Configurations in Flows.

View Your Callable Flow

You can view your callable flow in two ways: 

• Know the name of your flow and find it in the standard list of flows.

• Open the parent flow and view the flow in the Call a Flow step.

Callable flows are shown in the standard list of flows, so you will just need to know the name of your callable flow to find it here. Additionally, you can get to your callable flow from the parent flow that calls it. Open the Call a Flow step and choose the View Flow link under the name of your callable flow. This will open the callable flow in a new window.

Schema for a Callable Flow

Callable flows can define an input schema which will then be shown on the Call a Flow step in a parent flow. Define this schema by selecting the trigger in the callable flow and selecting Custom Schema. The input schema must follow the JSON Schema v7.0 format.

Data Returned from a Stop Step in a Callable Flow 

A callable flow has no output unless you define it using a Stop step. Include a Stop step for every exit scenario in your callable flow so the output to the parent flow is consistent. The Result Status, Result Message, and Result Details will all flow back to the parent flow. 

A Stop step configured as it appears in Figure 1 will appear in the parent flow as it does in Figure 2.

If a Stop step has the Result Status set to Failure, then the “__Status” property will be 400. 

Was this helpful? Give us feedback.