Userpilot quick info

Userpilot is in beta, and accepts Page, Identify, and Track calls. If you reference it in the Integrations object, call it “Userpilot”.

Userpilot accepts device-mode data only from Analytics.js.

Userpilot helps product teams increase user adoption by allowing them to trigger highly personalized onboarding experiences across the user journey. The Segment integration will help you install and send data to Userpilot without added development time.

This destination is maintained by Userpilot. For any issues with the destination, contact the Userpilot Support team.

This document is about a destination which is in beta

This means that the Userpilot is in active development, and some functionality may change before it becomes generally available.

Getting Started

Before you start, make sure Userpilot supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️ ⬜️
☁️ Cloud-mode ⬜️ ⬜️ ⬜️
  1. From the Segment web app, click Catalog.
  2. Search for “Userpilot” in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. Enter the “App Token” into your Segment Settings UI which you can find from your Userpilot dashboard within the code snippet that looks like this <script src = ""></script> where 73fe57o8 is the value you want to use.


If you’re not familiar with the Segment Specs, take a look to understand what the Page method does. An example call would look like:

Calling the page from analytics.js triggers the userpilot.reload method that will check for any current running experiences on that page and fetch any new experiences that satisfy the specifed page settings.


If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

analytics.identify('userId123', {
  email: ''

Calling identify from analytics.js will trigger the userpilot.identify. We recommend passing as much data as possible to get the most out of Userpilot.

Data passed in the identify can be organized under different categories.

  • Properties about the user such as plan or userRole to help targetting a specifc segment.
  • Properties to personlize the content of the Userpilot experiences such as name or company
  • Properties to target users based on their lifecycle such as createdAt. This will allow you to target newly created accounts or accounts that have yet to achieve a certain feature in the user lifecyle.


If you’re not familiar with the Segment Specs, take a look to understand what the Track method does. An example call would look like:

analytics.track('Clicked Login Button')

Calling track from analytics.js will trigger userpilot.track. This will send events data to Userpilot where it can be used for content triggering.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
App Token
string. You can retrieve your API Key from your Userpilot dashboard.

This page was last modified: 20 Oct 2020

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
Create free account