Overview

This article explains how UserGuiding integrates with Segment, a customer data platform that helps you collect, clean and control your customer data.

When Segment Integration is activated, UserGuiding can be used as a Source which sends event information to your Segment account then be routed to other systems.

If you were looking for information related to segmenting your users in UserGuiding but ended up here, you should click here.

Important Note: To successfully integrate, Segment should be a product that you've been using.

Further Reading: 6 Ways to be a better Product Manager with Segment

What do you need to activate Segment Integration?

To be able to use UserGuiding as a source in Segment (what we aim to have as a result of this practice), you should be using the Segment’s Analytics.js library.

Analytics.js, Segment’s Javascript source, makes it simple to send your data to any tool without having to learn, test, or implement a new API every time.

UserGuiding utilizes window.analytics as an object in the below snippet for tracking.

If you haven't already, copy and paste it high in the <head> of your website to complete integration with the Analytics.js library.

How To Activate Segment Integration

You can enable this integration by using the toggle within the Integrations Tab under the Settings Section.

How to set up UserGuiding as a Source into Segment

  • Go to your Segment workspace, and navigate to the Sources.
  • Click to Add Source and choose Javascript source.
  • Click Add Source in the opening window.

Or;

  • On the next screen, give the source a name. (We recommend that you include UserGuiding in the name so you can easily find it).
  • Type the full URL where the Segment's analytics.js is installed.

Event Tracking

When it is enabled as a Source of Segment, UserGuiding pushes out real-time event notifications to other services, in other words, to your Destinations in Segment.

This way, Segment allows you to track and analyze information about your Guides and NPS Survey then be routed to other systems.

If you go to the Debugger section of your UserGuiding source, you can see the real-time tracked event data in Segment workspace.

These events include;

1. Guide Preview Start:

It means that the first step of a guide is previewed by a user. To see which guide it is, click on the guide started (userguiding).

You'll see the guide's ID, name, and the URL of the page on which the user has seen its first step.

2. Guide Preview Complete:

It means that a user has gone through all steps of a guide and seen its last step. To see which guide it is, click on the guide completed (userguiding).

You'll see the guide's ID, name, and the URL of the page on which the user has seen its first step.

3. NPS Survey Display:

It means that your NPS Survey is seen by a user. To see the URL of the page in which the user has seen the survey, click on the nps survey shown (userguiding).

4. NPS Score Submit:

It means that a user has given you a certain NPS score. To see the NPS score value, click on the nps score submit (userguiding)

You'll see the survey question, and the URL of the page on which the user has seen the survey

5. NPS Feedback Submit:

It means that a user has given a written answer to the question of your NPS Survey. To see the answer, click on the nps feedback submit (userguiding)

6. Hotspot Interaction

It means that a user interacted with a hotspot group and seen a hotspot content. (remember, hotspot groups can have multiple hotspots as contents).

This event is sent only once in one UserGuiding script load (page refresh).

To see which hotspot it is, click on the hotspot interacted (userguiding).

You'll see the hotspot group ID, interacted hotspot's ID/title, name of the hotspot group, and the URL of the page on which the user interacted with the hotspot.

7. Checklist Item Trigger

It means that a checklist guide is triggered by a user. To see which guide is triggered from which checklist, click on the checklist item triggered (userguiding).

You'll see the checklist's name / ID, guide name / ID, and the URL of the page on which the user has triggered the guide from the checklist.

Destinations

In Overview, you can add multiple Destinations to your UserGiding source and send events to these integrations.

Related Articles:

Intercom Integration

Google Analytics Integration

Did this answer your question?