Triggering Flows


Once you have created your flow, It's time to determine how you would like to trigger it. With Userpilot, you can control when exactly to display a flow so that it appears at the perfect moment for your users.

This document defines the trigger settings for the flow that you can manage under the settings tab of a flow.

Trigger Settings

There are 3 options that can be used to determine when to trigger a flow:

1- Page-Specific: Trigger the flow when a user lands on a certain page in your web app

2- Event Occurrence:  when a user performs a certain action in your web app

3- Only-Manually:  programmatically or from other Userpilot content


When selecting this option, the flow will trigger based on the conditions that you can set up in the 'Page' section of the flow settings.
To dive deeper into the broad set of conditions that you utilize in the page targeting, check the page targeting document

Event Occurrence

This feature will provide you with the ability to trigger a flow at the exact moment that you want your users to see it, leading to a great and seamless experience for your users. It is highly recommended to pass tracked event metadata so you can utilize the event attributes option. Take the example below for instance where a flow is set to trigger for a user that just created their first invoice.

What are Events and how can I create them?

Userpilot provides three types of events, the events that you can utilize in Event Occurrences are called Feature Tags (aka no code-events) and Tracked events (aka code-events) 

Feature tags allow you to tag certain elements in your web app that you would like to track, without any interference with your dev team.

Tracked events can be passed through the JS snippet by calling userpilot.track(‘the event name’) whenever users take important actions in the app. 

Alternatively, event data can be sent to Userpilot through our REST API.

The Event Occurrence feature is available for Enterprise or Growth plans only, check the plans here


Manually triggering your flow is a great option in case you would like to trigger a flow only when a user clicks on it from a checklist task, Resource Center, or from another flow without automatically triggering the flow for an eligible user. This option can also be used for testing purposes before publishing the flow to your production web app

Ways to manually start your flow

1. Via Other Userpilot Content

You can trigger a flow from a button, or achecklist task, as well as the Resource Center.If you would like the flow to trigger only from Userpilot content without it triggering on its own, then selecting the option 'Only-manually' is the way to go.

2. Shareable Permalink

You can trigger a flow by adding the provided query to the end of any URL in your web app, and the flow will automatically start. This is a great option to test your flow internally and share it with your teammates. 

3. Trigger Programmatically

A JavaScript code is provided in case you can programmatically start the flow from e.g. a button in your app. You can simply copy the code and share it with your dev team to include it in the code of an element in your app

Important Note: Triggeinrg a flow manually will override all other flow settings such as the segment, domain, and page settings.

Next: Determine who is eligible to see your flow

Need help? Reach out to us at

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.