Start page

Setting the Start Page for a Product Tour

The start page is the initial page where the product tour begins. You can configure this page to provide users with a seamless experience, whether they access the tour through a Smartlink or Gleap's AI bot, Kai.

General Setup

To set the start page, specify the URL where you want the tour to begin. For example, if your tour starts at your homepage, you could set the start page as:

https://yourdomain.com/home 

This ensures users will land on the specified page when starting the tour through a Smartlink or Kai.

Using Dynamic URLs with Variables

Dynamic URLs allow you to personalize the starting page based on session or user-specific data. You can achieve this by using variables within the URL. For example:

/projects/{{session.customData.projectId}}

Here, {{session.customData.projectId}} is dynamically replaced with the user's projectId stored in the session.

How to Set Attributes with Gleap.identify()

To use variables effectively, you need to send user-specific data using the Gleap.identify() function. This method allows you to attach attributes to the current session. Here’s an example:

Gleap.identify("19283", {
    name: "Franz",
    email: "franz@gleap.io",
    phone: "+1 (902) 123123",
    value: 199.95,
    plan: "Pro plan",
    companyId: "12398958484",
    companyName: "ACME inc.",
    createdAt: new Date(),
    customData: {
        projectId: "project123",
        key1: "awesome",
        key2: true,
    },
});

If the projectId is stored as part of customData in the session, you can configure the start page URL like this:

/projects/{{session.customData.projectId}}

When Franz starts the tour, {{session.customData.projectId}} will be replaced with "project123", directing Franz to:

/projects/project123

Summary

By combining a static start page or a dynamic URL with Gleap.identify(), you can customize the product tour experience for your users. All session attributes set with Gleap.identify() are accessible for dynamic variable usage, enabling a highly personalized start page configuration.