Installing With Segment

Leverage the use of your Segment data by passing it along to Userpilot with no additional coding.

Common use cases

  • Using Segment data for targeting Userpilot Flows to specific users
  • Using Segment data for tracking conversion rates
  • Sending Segment tracked events to Userpilot

Segment as a data source

This article explains how to use Segment as a data source to sync your Segment information to Userpilot - e.g. user and company attributes and events.

Installing Userpilot on your app through Segment

Prerequisites

Before you begin, you will need to install Segment on your application. You can follow their guide here.

Installing Userpilot using the plugin

This will Install Userpilot on the client side where the data will be sent from the webpage itself.

Step 1: Sign in to Segment

To get started you first need to sign in to Segment or create a new account if you don’t have one Segment Sign up.

Step 2: Install Segment

You can skip this step if you have already installed Segment on your web app.

1. Install Segment on your application. You can follow their guide here.

2. To pass user properties to Userpilot from Segment and show the Userpilot content correctly, Segment's Identify method analytics.identify must be called on every page reload. Without identifying the user, Userpilot won't attempt to show content to the users.

Step 3: Create source on Segment

You can skip this step if you have already created a source.

1. From the main menu, click on the Catalog tab then choose "Javascript" under Website.

2. Click on the “Add Source” button.

3. Change the name to "Userpilot" for instance, and input the desired URL for installing analytics.js. Lastly, click on the "Add Source" button.

Step 4: Install Userpilot from Segment

Use Case: Integrate Userpilot content via the Segment analytics.js library.

Supported Sources: Website (JavaScript)


  1. From the main menu, click on the Catalog tab, then click on the Destination tab install.
  2. Search for and select "Userpilot Web (Actions)".

  1. Click on the "Add Destination" button.

  1. Choose the source you want to pass the data from and continue the setup steps

  1. After completing the setup steps, fill out the app token field with your token.

You can find your App Token under the Environment tab or the Installation tab


Passing data through a backend service

In order to send data to Userpilot through a back-end server, you will need to follow the steps below

Use Case: Send user-specific events and attributes from your backend to Userpilot.

Supported Sources: Website (JavaScript), Server (Node.js, Go, PHP, Elixir, etc.)

  1. Head over to the Connections tab and click on "Add destination" in destinations.

  1. Search for Userpilot and choose "Userpilot Cloud".

  1. Choose the source you want to pass the data from.


  1. Enter a name for your newly created destination
  2. Fill in the required values, you can find the API Key and the API Endpoint in your Userpilot account under the Environment tab, please make sure to copy the correct values.

Mappings: We support "identify" and "track" methods by default.

Special Note(s) for Cloud Destination: To associate a company attribute with a user, send the company details with your user configurations. Refer to our "identify method" documentation for guidance.


Note: If you have Userpilot installed via Segment, then the event will be passed to Userpilot as soon as the method analytics.track() is called. For more details on the segment track method, you can check here

If you have questions regarding our Segment integration, please reach out to us at support@userpilot.co

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.