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 that sends event information to your Segment account and then be routed to other systems; and also as a destination where you can send your user events and attributes.
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 you've been using.
Further Reading: 6 Ways to be a better Product Manager with Segment
UserGuiding as Source
To be able to use UserGuiding as a source in Segment, 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 snippet below 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 using the activate button within the Integrations Tab under the Settings Section.
In the opening menu, you can toggle on and activate the integration.
How to set up UserGuiding as a Source in 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;
Go to your Segment workspace, and navigate to the Sources catalog.
Choose Javascript source and click Add Source in the opening window.
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 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 the Segment.
This way, Segment allows you to track and analyze information about your onboarding content and 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 the Segment workspace.
These events include;
Guide Preview Start
It means that a user previews the first step of a Guide. To see which Guide it is, click on the guide started (userguiding).
You'll see the Guide's ID, name, and URL of the page on which the user has seen its first step.
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 URL of the page on which the user has seen its first step.
Survey Question Answer (Score, Emoji, Choices, Written Feedback)
It means that a user has given you a certain score or selected an emoji, option, or written feedback. To see the value, check under survey question answer (userguiding).
You'll see the survey question, the URL of the page on which the user has seen the survey, and the user ID.
Survey Shown
"survey shown (userguiding)",
{
surveyId: 1,
surveyName: "Survey Name",
pageUrl: "https://panel.userguiding.com/dashboard"
}
Survey Question Answer (score)
"survey question answer (userguiding)",
{
surveyId: 1,
surveyName: "Survey Name",
questionId: "f4411b5d-7544-477a-b605-5c8622cb5c8b",
questionType: "Star Rating" | "Number Rating (5)" | "Number Rating (10)" | "NPS Rating",
surveyQuestion: "How likely are you to recommend this product to a friend or colleague?",
score: 5,
pageUrl: "https://panel.userguiding.com/dashboard",
}
Survey Question Answer (emojiScore)
"survey question answer (userguiding)",
{
surveyId: 1,
surveyName: "Survey Name",
questionId: "d82cf468-6dae-4813-a3e2-1ba740254aa1",
questionType: "Emoji Rating" | "Thumbs Up/Down",
surveyQuestion: "How would you describe your experience with our product using emojis?",
emojiScore: "Positive" | "Neutral" | "Negative",
pageUrl: "https://panel.userguiding.com/dashboard",
}
Survey Question Answer (choices)
"survey question answer (userguiding)",
{
surveyId: 1,
surveyName: "Survey Name",
questionId: "23300f80-4002-461e-b179-559094c82496",
questionType: "Multiple Choice",
surveyQuestion: "Which of the following options best describes your role?",
choices: "Choice 1,Choice 2",
pageUrl: "https://panel.userguiding.com/dashboard",
}
Survey Question Answer (feedback)
"survey question answer (userguiding)",
{
surveyId: 1,
surveyName: "Survey Name",
questionId: "81d6c621-d74c-4590-b35e-9d5abc3c49d5",
questionType: "Written Feedback",
surveyQuestion: "Please provide any comments or feedback regarding your experience with our service.",
feedback: "User's feedback",
pageUrl: "https://panel.userguiding.com/dashboard",
}
Hotspot Interaction
It means that a user interacted with a Hotspot group and saw Hotspot content. Remember, Hotspot groups can have multiple Hotspots as contents.
This event is sent 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, the name of the Hotspot group, and the URL of the page on which the user interacted with the Hotspot.
Checklist Item Trigger
It means that a user triggers a Checklist item. To see which item 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.
Checklist Item URL Click
It means that the user clicks a URL item on a Checklist. To see which item is clicked from which Checklist, click on the checklist item url click (userguiding).
You'll see the Checklist's name / ID, the URL of the item, and the URL of the page on which the user has clicked on the item in the Checklist.
Checklist Complete
It means that the user completed a Checklist. To see which Checklist, click on the checklist completed (userguiding).
You'll see the Checklist's name / ID and the URL of the page on which the user has completed the Checklist.
Resource Center Guide Trigger
It means that the user triggers a Resource Center Guide. To see which Guide it is, click on the resource center guide triggered (userguiding).
You'll see the Resource Center's name / ID, Guide name / ID, and the URL of the page on which the user has triggered the Guide from the Resource Center.
Resource Center Checklist Guide Trigger
It means that a Guide in a checklist put in a Resource Center as a module is triggered by a user. To see which Guide it is, click on the resource center checklist guide triggered (userguiding).
You'll see the Resource Center's name / ID, Checklist's name / ID, Guide name / ID, and the URL of the page on which the user has triggered the Guide from the Checklist within the Resource Center.
Resource Center Checklist Item URL Click
It means that a URL item in a Checklist put in a Resource Center as a module is clicked by a user. To see the item information, click on the resource center checklist item url click (userguiding) inside recent events.
You'll see the Resource Center's name / ID, Checklist's name / ID, Item URL, and the URL of the page on which the user has clicked the item from the Checklist within the Resource Center.
Resource Center External URL Click
It means that a user clicks an external URL in a Resource Center. To see which external URL is clicked from which Resource Center, click on the resource center external url clicked (userguiding).
You'll see the Resource Center's name / ID, external URL, and the URL of the page on which the user has clicked on the external URL within the Resource Center.
Resource Center Article Link Click
It means that a user clicks a search article in a Resource Center. To see which search article is clicked from which Research Center, click on the resource center article link clicked (userguiding).
You'll see the Resource Center's name / ID, article link, and the URL of the page on which the user has clicked on the article link within the Resource Center.
Resource Center Survey Trigger
It means that a Survey in a Resource Center as a module is triggered by a user. To see which Survey is triggered from which Resource Center, check under resource center survey trigger (userguiding).
💡Please note that the existing events associated with the now-deprecated Promoter Surveys will remain unchanged; however, they will be emitted in their new format.
Destinations
In Overview, you can add multiple Destinations to your UserGiding source and send events to these integrations.
UserGuiding as Destination
To be able to use UserGuiding as a destination for the user attributes and events in Segment, you should use the Segment web application.
How To Activate Segment Integration
You can enable this integration using the activate button within the Integrations Tab under the Settings Section.
In the opening menu, you can toggle on and activate the integration. Here, you can also find the API Key to add UserGuiding as a Destination on your Segment account.
How to set up UserGuiding as a Destination in Segment
Go to your Segment workspace and navigate to the Destinations under Connections.
Click Add Destination
Select your data source & click Next
Write a destination name on the opening page
Select Classic as a Destination Framework
Click Create Destination
Paste the API key provided in the Token section
Click Save
Or;
Go to your Segment workspace and navigate to the Catalog under Connections.
Search for UserGuiding
Complete the settings as explained above
When you complete the integration, you will see the user attributes and user events on the Users Page.