Overview
This article explains how UserGuiding integrates with Mixpanel, a platform that helps you analyze user data in real-time to identify trends and understand user behavior.
When Mixpanel Integration is activated, you can more deeply analyze and target the user onboarding experience you created with UserGuiding.
By setting up onboarding, activation, and retention funnels in Mixpanel, you can also test and adjust your Guides for these metrics.
The integration works in two directions. UserGuiding as a Source sends UserGuiding events to Mixpanel. UserGuiding as a Destination syncs Mixpanel cohorts into UserGuiding as segments.
UserGuiding as a Source: Sending UserGuiding Events to Mixpanel
You can start by going to your Mixpanel account and navigating to the project you want your UserGuiding events to stream.
Then go to your 'Project Settings' through the menu shown below.
Under 'Access Keys' there, you can find your 'Project Token' and copy it.
Then sign into your UserGuiding account, go to your Integrations Tab under Settings, and click Activate for Mixpanel.
On the opening pop-up, paste your Mixpanel 'Project Key' you copied. If your Mixpanel project data is on EU servers, you should select the 'EU Data Residency' option. If not, use 'Standard Server', then click 'Save'.
You are all set! UserGuiding will immediately start sending onboarding material engagement data, for each user, to your Mixpanel account.
Event Tracking
Once activated, you can find UserGuiding data as custom events in Mixpanel, ready to be used as part of any Mixpanel chart, report, or funnel.
To check how a particular user performs with your UserGuiding Onboarding material, go to Users > Explore > X User > and examine the event data in the Activity Feed.
Event Format
<EVENT_NAME>
<EVENT_PROPERTIES>
Event Example
banner button click (userguiding)
bannerId: 36
bannerName: Banner Name
buttonId: 0910f959-f611-4f42-9337-3964d7f9e005
ctaText: Explore Now
userId: USER-IDpageUrl: https://panel.userguiding.com/dashboard
Find the list of all events UserGuiding emits to integrated tools in this article.
UserGuiding as a Destination: Syncing Mixpanel Cohorts into UserGuiding
You can also send Mixpanel cohorts into UserGuiding. Each synced cohort becomes a UserGuiding segment that you can target Guides, Surveys, Checklists, and other materials with. Membership updates automatically as the cohort changes in Mixpanel.
Before you start: Your UserGuiding plan must include incoming integrations. User Identification must be enabled in your UserGuiding project, and the Mixpanel distinct_id of your users must be the same value as the User ID you send to UserGuiding. If a cohort member's distinct_id does not match any existing UserGuiding user, a new user with that ID is created in UserGuiding and added to the segment. Cohort sync via Custom Webhook is a Mixpanel feature available on paid Mixpanel plans.
Step 1: Get your destination URL and credentials from UserGuiding
Go to Settings > Integrations > Mixpanel and open the "UserGuiding as Destination" tab. Turn the toggle on. You will see a Destination URL, a Basic Auth Username, and a Basic Auth Secret. Keep this tab open, you will paste these into Mixpanel next.
Step 2: Create a Custom Webhook destination in Mixpanel
In Mixpanel, go to Data > Destinations, click "Add Destination", and choose Custom Webhook. Give the destination a name (for example, "UserGuiding"), paste the Destination URL from UserGuiding as the URL, and enter the Basic Auth Username as Username and the Basic Auth Secret as Password. Under "Properties To Export", add any Mixpanel profile properties you want written to your UserGuiding users as attributes (for example $email, $name, $city). Save the destination. The Configuration tab of the destination shows these values afterwards, and you can change the exported properties there later.
Step 3: Add cohort syncs to the destination
Open the destination, switch to the "Syncs" tab, and click "Add Cohort Sync". Pick the cohort you want to sync into UserGuiding and choose "Recurring" as the frequency so membership changes keep flowing. Repeat for each cohort; a single destination can hold up to 60 recurring cohort syncs. The Syncs tab lists every cohort with its last export time, exported profile count, and status.
What happens in UserGuiding
A new segment named after the cohort appears under Segments with Mixpanel as its source. Users in the cohort who already exist in UserGuiding are added to the segment. Users UserGuiding has not seen yet are created with Mixpanel as their source and are added to the segment, so they are targeted as soon as they show up in your product. Anonymous Mixpanel profiles (those with a $device: distinct ID) cannot be matched to a UserGuiding user and are skipped. The slider shows how many members from the last sync could not be matched.
Exported properties as user attributes
Mixpanel's email, first_name, last_name fields and the properties you listed under "Properties To Export" on the destination are saved as UserGuiding user attributes. A leading $ is removed and dots are replaced with __ (for example $city becomes city, plan.tier becomes plan__tier). By default these attributes are written only to users that the sync created. Turn on "Also write these properties to existing users" in the slider if you want Mixpanel values to overwrite the same attributes on users that already exist in UserGuiding.
Regenerating the secret
Click "Regenerate Secret" in the slider if the secret is exposed. The previous secret stops working immediately, so update the Password on the Custom Webhook destination in Mixpanel with the new secret right after.