Overview
By enabling User Identification, you will send unique user IDs for your end users dynamically to have persisted user data for your end-users at UserGuiding.
Implementing User Identification requires access to your web platform or site's source code which is one of the 3 environments you will take specific actions to succeed.
ο»Ώ1) panel.userguiding.com
Here, you'll find the directions for adding the identify snippet.
Copy the example snippet given here(1), that soon, you will use it inside your Custom Tag at GTM.
See image 1:
[image 1]
2) Google's Tag Manager
Login to your Google Tag Manager account, where you'll use the identify snippet copied from UserGuiding's dashboard.
πͺ Next, you will create a Trigger, a Variable, and a Tag in your GTM account.
We will use example variables that could be different in your implementation to demonstrate. You can name and configure these variables as you need.
a) Create a Trigger: Here, you should create a Custom Event Trigger.
The function of this custom event Trigger is to tell the Tag (having the identify snippet) to fire when the specified event is detected.
βImportant: Inside your web platform's source code, you should have a code to push the Trigger's custom event into the Data Layer.
See image 2: We created a Custom Event Trigger named "identifyUser."
This way, the Tag Manager can detect identifyUser as a custom event value and fire the Tag.
[image 2]
b) Create a Variable: You should create a Data Layer Variable.
Each user ID you want to send to UserGuiding is an individual value. Thus, the Data Layer Variable you create will be the placeholder for these values.
Important: Inside your web platform's source code, you should push data (user IDs) to the data layer to set values for the data layer variable. Learn more.
See image 3: We created a variable named "userId."
The value will be set when data is pushed to the data layer.
[image 3]
c) Create a Tag: You should create a Custom HTML tag.
This is where you will use the identify snippet copied from panel.userguiding.com and your configurations so far.
See image 4: We created a Tag named "UserGuiding - User Identification."
With this Tag, we are ready to send user IDs to UserGuiding via GTM.
[image 4]
After adding your Tag, SAVE it and publish changes in your GTM account.
πͺ To make sure your tag configurations function as expected, you can preview and debug containers at GTM.
Finally, return to your UserGuiding panel (installation section) and click Enable Identification button at the bottom left. Then, click Publish Changes button on the top-right.
3) Your Source Code:
[actions below are previously mentioned]
Implementing User Identification requires access to your platform's source code. We have already shared two Important notes with you, as you might recall.
1* Important: Inside your web platform's source code, you should have a code to push the custom event into the Data Layer.
2* Important: Inside your web platform's source code, you should push data (user IDs) to the data layer to set values for the data layer variable. Learn more.
User Identification Enabled:
Once it is enabled and active, you will be able to access your API Key (API Access Token) in the section shown below:
You can use our API Documentation to see how to utilize the User API.
We recommend you get support from your development team and use an API Development Environment to access this data. Postman is an excellent alternative for this task.
How to test if user IDs are being sent successfully?
You can utilize the User API to check if the user IDs you sent to UserGuiding have successfully arrived.
Alternatively, as a current and one of the identified users (a unique ID is sent for you), you can access one of your platform pages where UserGuiding's container code is installed.
β
Here, open the Troubleshooter and view Current User Information to find your unique ID.
As you can see from the image below, User Identification is Completed β for the current user because a unique ID is assigned to them.
Their unique User ID is 10149.
