Set Step Timeout Duration for Flows

Updated On 04 Jun 2024
1 Minute To Read

Print
Share
Dark

Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Step Timeout Duration is a single configuration field used to control how long Whatfix should try to find and execute a mandatory step in a Flow before timing out. This means that Whatfix waits for the end user to perform an action before moving on.

By defining a maximum total time using the Step Timeout Duration field, Whatfix tries to locate the next step within the specified duration, attempting at default intervals of 500 milliseconds.

your title goes here

Configuring the Step Timeout Duration value affects all mandatory steps across all Flows within the account. Mandatory steps are all those default steps that the user has to complete before moving on to the next step.
The default value for Step Timeout Duration is 60,000 milliseconds (which equals 60 seconds or 1 minute).

Consider that you have a step where users need to click a button. You set the Step Timeout Duration to 30 seconds. Now, when a user reaches this step, Whatfix starts searching for the button every 500 milliseconds for up to 30 seconds. If the user clicks the button within this time frame, Whatfix proceeds to the next step. However, if the button isn't clicked within 30 seconds, Whatfix considers the step as failed or timed out. This global setting ensures that Whatfix maintains a consistent user experience across all Flows by defining how long it should wait for the end user to perform an action before moving on.

Use the following steps to set Step Timeout Duration for all Flows using the Whatfix dashboard:

On the Whatfix Guidance dashboard, click Settings.
Click Advanced customisation.
Click Technical configuration.
Click Add preferences.

Click Flows.
Select the Step Timeout Duration (ms) checkbox.
Click Add.
In the Step Timeout Duration (ms) value field, enter the desired integer value.
Click Save.