Amplitude Integration

Learn how to set up and use Amplitude integration using UserGuiding as a source and setup Amplitude Cohort Sync with UserGuiding segments.

Overview

This article explains how UserGuiding integrates with Amplitude, a platform that helps you analyze user data in real-time to identify trends and understand user behavior.

When Amplitude Integration is activated, you can more deeply analyze and target the user onboarding experience you created with UserGuiding and sync your Amplitude cohorts with UserGuiding segments.

By setting up onboarding, activation, and retention funnels in Amplitude, you can also test and adjust your Guides for these metrics.

How To Activate Amplitude Integration

You can start by going to your Amplitude account. Navigate to 'Data' first from the top menu, then go to 'Sources' under 'Connections' from the menu on the left, then click 'Add Source' from the top right.

Search for 'UserGuiding' and click on the UserGuiding card.

On this page, you will find your 'API Key'. Copy this API Key.

Then sign in to your UserGuiding account, go to your Integrations Tab under Settings, and Click Activate.

UserGuiding as a Source

This integration syncs cohorts from Amplitude to UserGuiding segments constantly.

You are all set! UserGuiding will immediately start sending onboarding material engagement data, for each user, to your Amplitude account.

Event Tracking

Once activated, you can find UserGuiding data as custom events in Amplitude, ready to be used as part of any Amplitude chart, report, or funnel.

To check how a particular user performs with your UserGuiding Onboarding material, go to User Look-Up and click on a user.

When you scroll down on the left-hand side, you will see the events performed by the user. If you click on an event on the right-hand side, you will see the details of the event. You can find UserGuiding event metadata under 'Event Properties' there.

Event Tracking

UserGuiding pushes out real-time event notifications to Amplitude when it is enabled as a Source.

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.

UserGuiding as Destination (Amplitude Cohort Sync)

This integration allows you to sync cohorts from Amplitude to UserGuiding segments constantly. Toggle UserGuiding as a Destination option on the opening drawer and copy the 'API Key' shown.

In Amplitude, navigate to the Cohorts page. You can select the cohort you want to sync to UserGuiding. Click Sync to…, Destinations Page, and View All Destinations. Find and select UserGuiding. Click Add another destination. You can add a name here, such as the account name. Paste the API key you copied from UserGuiding and save your changes.

Navigate back to the cohort you wanted to sync to UserGuiding. You should reload the page to continue. Click Sync to… → UserGuiding. Here, you can choose whether to do a one-time or recurring sync and save your changes.

Once Amplitude starts syncing, you can see the cohort as a segment on your Users page in UserGuiding.

Important: Under User ID Mapping, choose User ID on the Amplitude side. You must use the same user ID in Amplitude and UserGuiding.

Important: Kindly be aware that the Amplitude Cohort Sync will be available only for Growth & Enterprise Plans.

Did this answer your question?