Using custom data | FlowNavi Help

Your app can tell FlowNavi two kinds of things about the user in front of it. Properties decide who sees a flow. Variables fill in what a guide says and where it links.

	Properties	Variables
Used for	Deciding who sees a flow	Text and URLs inside a guide
Example	Show a tour only to admins	“Welcome, Anna!”
Passed with	`identify`	`setVariables`
Stored by FlowNavi	Yes	No
Personal data such as a name	Don’t send it	Fine to use

Properties

Pass properties

Pass them as the second argument to identify:

window.FlowNavi.identify("USER_ID_FROM_YOUR_APP", {
  role: "admin",
  plan: "pro",
  signedUpAt: "2026-01-15"
});

Values are strings, numbers or ISO dates. For company properties, see Pass company properties.

Use properties in the editor

In the editor, click On page load and add a rule under Segmentation, for example role = "admin". The flow then appears on its own only for users who match every rule. See Segmentation.

Variables

Pass variables

window.FlowNavi.setVariables({
  name: "Anna",
  workspace_id: "42"
});

Call setVariables before identify, so guides are filled in when they first appear.
Call it again when a value changes, with only what changed. Guides on screen update right away.
Allowed values: strings and numbers.
Variable values never leave the user’s browser. FlowNavi only receives the names, to list them in the editor.

Use variables in the editor

Type a variable in curly braces wherever you type text or a URL:

Where	You type	The user sees
Text	`Welcome, {name}!`	Welcome, Anna!
Button label	`Open {name}'s workspace`	Open Anna’s workspace
Button URL	`/workspaces/{workspace_id}`	Opens `/workspaces/42`

To see which variables your app sets, click the ⋮ menu at the top of the editor and choose Variables. Click a variable to copy it. A variable is listed once your app has set it.

A variable your app has not set is shown as written, for example Welcome, {name}!.

In Preview, each variable is filled with a placeholder such as preview:name, not with the value from your app. Change the values under Variables in the preview panel to test with realistic ones.