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 routes it to other systems and 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 use UserGuiding as a source in Segment, you should use Segment’s Analytics.js library.
Analytics.js, Segment’s Javascript source, makes sending your data to any tool simple 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.
This means that a user previews the first step of a guide.
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.
Event Format
<EVENT_NAME>
<EVENT_PROPERTIES>
Example Event
banner button click (userguiding)
bannerId: 36
bannerName: Banner Name
buttonId: 0910f959-f611-4f42-9337-3964d7f9e005
ctaText: Explore Now
userId: USER-ID
pageUrl: https://panel.userguiding.com/dashboard
Find the list of all events UserGuiding emits to integrated tools in this article.
Destinations
In Overview, you can add multiple Destinations to your UserGuiding source and send events to these integrations.
UserGuiding as Destination
To use UserGuiding as a destination for user attributes and events in Segment, please use the Segment web application. Note that adding UserGuiding as a destination is available for Growth Plan users and above. Also, keep in mind that company attributes and events cannot be sent to UserGuiding.
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
Learn How to add a Destination
- Search for UserGuiding from your workspace's Destination catalog page.
- Select UserGuiding, and click Add Destination.
- Choose the source you want to connect UserGuiding destination to.
- Give the destination a name.
- Enter the API key provided in the UserGuiding integrations page.
- Pick the data residency region for your UserGuiding account.
When you complete the integration, you will see the user attributes and user events on the Users Page.