Skip to contentSkip to navigationSkip to topbar
Page toolsOn this page
Looking for more inspiration?Visit the

Userpilot Web Plugin


Destination Info
  • Accepts Page, Identify and Track calls.
  • In Device-mode, refer to it as Userpilot in the Integrations object
  • This integration is partner owned. Please reach out to the partner's support for any issues.
Connection Modes
Device-modeCloud-mode
Web Web
Mobile Mobile
Server Server

Userpilot Web Plugin(link takes you to an external page) 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.


Getting Started

getting-started page anchor
  1. From the Segment web app, click Catalog.
  2. Search for Userpilot Web Plugin in the Catalog, select it, and choose the source you want to connect the destination to.
  3. Enter the App Token into your Segment Settings UI which you can find from your Userpilot dashboard(link takes you to an external page) within the code snippet that looks like this <script src = "https://deploy.userpilot.io/73fe57o8.js"></script> where 73fe57o8 is the value you want to use.

Calling Page from analytics.js triggers the userpilot.reload method, which checks for any running experiences on that page and fetches new experiences that satisfy the specified page settings. See the Page method in the Segment Spec for details. An example call looks like:

Page call example

page-call-example page anchor
analytics.page()

Calling Identify from analytics.js triggers userpilot.identify. See the Identify method in the Segment Spec for details. An example call looks like:

1
analytics.identify('userId123', {
2
email: 'john.doe@example.com'
3
});

Segment recommends passing as much data as possible to get the most out of Userpilot. Data passed in the identify call can be organized under different categories:

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

Calling Track from analytics.js triggers userpilot.track, which sends event data to Userpilot where it can be used for content triggering. See the Track method in the Segment Spec for details. An example call looks like:

analytics.track('Clicked Login Button')

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

Property nameTypeRequiredDescription
App Tokenstring
required

You can retrieve your API Key from your Userpilot dashboard(link takes you to an external page).