Guide settings

Learn how to manage guides via their settings with UserGuiding

Gabriel avatar
Written by Gabriel
Updated over a week ago


In UserGuiding, you can manage your guides through their settings page. This article explains all of the subsections falling under guide settings.


As the name implies, you can change the status of a guide here. It can be active or inactive. To display guides for end-users, its status should be active. And to make it invisible, you can change it as inactive.

The Guide ID: It is next to the Status Field on top.

Guide Name: This is the section where you can edit a guide's name and description.

Page Targeting

Targeting is how you determine on what page or pages you want a guide or some other content to display.

A target is composed of a Rule and a URL bit and, its functioning is depicted as it is read from left to right.

Let's all look at the Guide's targeting that is shown us here below:

If a page's URL equals, this means the sample guide will be displayed on it.

To have in-depth information, see also: What is Targeting?

Audience Segmentation

You can target all your users, only yourself, or specific audiences to see and interact with your Guides. When choosing the latter, your end-users must meet all segment rules to be included in it.

To learn how to create user segments, check this article.


In this section, you can define how your Guide will be triggered for your end-users. You can learn it in detail here.


This is the default triggering method. It means that the Guide will automatically show up to end-users that arrive on the targeted pages and match the segmentation conditions.

When turned on, you can also set the Appear Frequency using one of the options below.

  • Only Once: your Guide won't be displayed anymore once seen.

  • Once a Session: your Guide will be shown on each new browser session. A new session is defined when you access a website on a new browser tab/window.

  • Once a Day: your Guide will be displayed only once a day.

  • Once a Week: your Guide will be displayed only once a week.

  • Once a Month: your Guide will be displayed only once a month.

  • Always: your Guide will always be displayed to your users.

Custom Triggers

When Auto-Trigger is turned off, your Guide won't show up unless you trigger it with one of the following methods:

  • Triggering a Guide through a Checklist or Resource Center.

  • Triggering a Guide by using a hyperlink.

  • Triggering a Guide by calling userGuiding.previewGuide(guide_id) with Javascript. Learn more here.

  • Events and triggers in Google Tag Manager.

  • Any prerequisite action to trigger a guide.

Important: The Guide ID is located under the Guide's Settings Page above the status.

Advanced Settings


Containers in UserGuiding are JavaScript code snippets used to install UserGuiding on web applications.

Each content you create, such as guides, hotspots, checklists, etc., should be placed inside the embedded container code to be displayed within your app.

At first, a guide is set to your default container. You can take a guide from one embed code and place it in another by changing its container.

To have in-depth information, see also: What are the Containers?


Guides that you create with UserGuiding can look native-like if you set a custom theme to them, befitting your web application.

To learn how to create a custom theme for your guides, you can read: Creating Themes.

Important: To preserve and publish the current setting of a Guide or any other content, always remember to Save and click on the green publish changes button.

Publishing changes will make your Guide's final state visible on your webpage.

Did this answer your question?