Salesforce Docs Portal

Show a Custom Error Message in a Screen Flow

Add a fault path to a screen flow to show a helpful message when an element fails.

Required Editions

View supported editions.
User Permissions Needed
To open, edit, create, activate or deactivate a flow using all flow types, elements, and features available in Flow Builder, including Einstein and Agentforce for Flow: Manage Flow
Note
Note You don't need to be an admin to have the Manage Flow permission. Ask your admin to add it to your profile or permission set.

Use this approach only for a flow that can show screens. A custom error message gives the person running the flow useful guidance when an element fails.

  1. Open the Flows list view.
    • From the Automation app, select the Flows tab.
    • From the Flows tab in any Lightning app, click the actions menu and select Open Flow.
    • From Setup, in the Quick Find box, enter Flows, and then select Flows.
    Note that the Automation app and Flows tab options don't require Setup access.
  2. Open the screen flow that you want to update in Flow Builder.
  3. Create a text template that contains a helpful error message. For instructions, see the Create and Configure the Text Template section of Send Emails with a Flow Using Text Templates. 
    <p><b>Something went wrong with this flow.</b></p>
<p>Contact your administrator for help.</p>
  4. For an element that can fail, click the three dots, and then select Add Fault Path.
  5. Add a Screen element to the fault path.
    1. On the fault path, click Add element plus icon., and then select Screen.
    2. Enter a label for the screen, and then accept the API name autofill.
    3. In Components, select Display Text.
    4. In the text box, in the Insert a resource field, select the text template that you created.
    5. Click Done.
  6. If the person running the flow can correct the error, connect the error screen to the screen where they can correct the input that caused it.
    1. After the error screen, click Add element plus icon., and then select Connect to element.
    2. Select the screen where the person can correct the input.
  7. For each additional element that needs a fault path, add the error screen and connect it to a screen where the person running the flow can correct the input that caused the error.
  8. Save the flow.

See Also