This article explains how UserGuiding integrates with Segment, a customer data platform that helps you collect, clean and control your customer data.
When it 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.
In order to learn more about how to set up UserGuiding as a Source into Segment, continue reading.
Important Note: Segment should be a product that you've been using. We do not provide the product itself as a part of your subscription to UserGuiding.
How To Activate Segment Integration
We enable this feature on behalf of you. By contacting our support team through any communication channel, you can let us know that you want to participate in our Beta Test for the solution.
How to set up UserGuiding as a Source into Segment
- Go to your Segment workspace, and navigate to the Sources.
- Click Add Source in the opening window.
- Go to your Segment workspace, and navigate to the Sources catalog.
- 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.
To be able to use UserGuiding as a source, you should be using the Segment’s Analytics.js library.
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.
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 Displayed:
It means that a user interacted with a guide. To see which guide it is, click on the guide started (userguiding). You'll be able to see the guide's ID, name, and the URL of the page in which the user has seen the guide.
2. Guide Completed:
It means that a user has gone through all steps of a guide and successfully completed it. To see which guide it is, click on the guide completed (userguiding).
You'll be able to see the guide's ID, name, and the URL of the page in which the user has seen the guide.
3. NPS Survey Displayed:
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 Submitted
It means that a user has given you a certain NPS score. To see the actual value of it, again click on the nps score submit (userguiding)
5. NPS Feedback Submitted
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)
In Overview, you can add multiple Destinations to your UserGiding source and send events to these integrations.