Get Values from Flow Output Variables

When you embed a flow in a lightning-flow component, you can show or reference the flow’s variable values.

To use this component, build a flow with the Salesforce Flow Builder first. The component includes the navigation buttons Back, Next, Pause, and Finish.

If your flow has custom Lightning web components or Aura components, then you can’t use lightning-flow on Experience Cloud sites that use Lightning Web Runtime.

Note

Use the onstatuschange Event Handler

To get values from the flow’s output variables, use the onstatuschange event handler. Output variables are returned as an array. The variable must allow output access. If you reference a variable that doesn’t allow output access, attempts to get the variable are ignored.

Example: Display Output Variables from Flow

This example takes the flow’s output variables for accountName and numberOfEmployees and displays them in the template.

1<!-- myComponent.html -->
2<template>
3  <p>{accountName}</p>
4  <p>{numberOfEmployees}</p>
5  <lightning-flow flow-api-name="myFlow" onstatuschange={handleStatusChange}> </lightning-flow>
6</template>

1// myComponent.js
2import { LightningElement, track, wire } from "lwc";
3
4export default class MyComponent extends LightningElement {
5  accountName;
6  numberOfEmployees;
7
8  handleStatusChange(event) {
9    if (event.detail.status === "FINISHED") {
10      const outputVariables = event.detail.outputVariables;
11      for (let i = 0; i < outputVariables.length; i++) {
12        const outputVar = outputVariables[i];
13        if (outputVar.name == "accountName") {
14          this.accountName = outputVar.value;
15        } else {
16          this.numberOfEmployees = outputVar.value;
17        }
18      }
19    }
20  }
21}

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.