Navigate To Flow

For base apps (web apps), this action is used to navigate to a flow in the current application, and if necessary, to pass parameters to the flow.

For App UIs, this action is used to navigate to a flow in the current App UI, and if necessary, to pass parameters to the flow. To navigate to a flow in a different App UI, use the Navigate to Application action.

This table describes the parameters for the Navigate To Flow action:

Parameter Name	Description
target	Specifies if the flow is for the current or parent page.
flow	Flow within the current App UI to navigate to.
page	Page within the flow to navigate to.
params	An object with the parameters to pass to the flow, if required.
history	Define the effect on the browser history. Allowed value are 'replace', 'skip' or 'push'. If the value is 'replace', the current browser history entry is replaced, meaning that back button will not go back to it. If the value is 'skip', the URL is not modified. Default is 'push'.

Here's an example of a call to the Navigate To Flow action, in which two input parameters are passed to the flow:

    const navFlowResult = await Actions.navigateToFlow(context, {
        target: 'parent',
        flow: 'main',
        params: {
          inParam: $page.variables.var1,
          inParm1: $page.variables.var2,
        },
        page: 'main-start',
        history: 'push',
    });