Userlist Destination

Userlist.io allows you to send behavior-based messages to your SaaS users. It’s great for onboarding users as well as nurturing them throughout their journey.

This destination is maintained by Userlist.io. For any issues with the destination, please reach out to their team.

NOTE: The Userlist.io Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on April 5, 2019. If you are interested in joining their beta program or have any feedback to help improve the Userlist Destination and its documentation, please let their team know!

Getting Started

The first step is to make sure Userlist supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

WebMobileServer
📱 Device-mode
☁️ Cloud-mode
  1. From your Segment UI’s Destinations page click on “Add Destination”.
  2. Search for “Userlist” within the Destinations Catalog and confirm the Source you’d like to connect to.
  3. Drop in the “Push API Key” into your Segment Settings UI which you can find from your Userlist.io Push API settings.

NOTE: The Userlist.io Destination does not support tracking of anonymous users, so please make sure to call identify before calling track. If you do call track on unidentified users, you will receive a 400 error which you can disregard if it was intentional.

Identify

If you haven’t had a chance to review our spec, please take a look to understand what the Identify method does. An example call would look like:

analytics.identify('userId123', {
  email: 'john.doe@segment.com',
  name: 'John Doe',
  role: 'Owner',
  createdAt: '2019-03-21T12:12:54.735+01:00'
});

Identify calls will be sent to Userlist.io as user records. If the userId is already known, it’ll update the user record, otherwise it’ll create a new one.

Here’s how Segment fields map to Userlist users:

Segment fieldUserlist fieldDescription
userIdidentifierThe unique identifier for this user.
traitspropertiesAdditional properties describing the user.
traits.emailemailThe user’s email address.
traits.createdAtsigned_up_atThe time when the user was created.

Track

If you haven’t had a chance to review our spec, please take a look to understand what the Track method does. An example call would look like:

analytics.track('Project created', {
  projectName: 'Party Planning'
});

Track calls will be sent to Userlist.io as a new event. You may send additional properties to describe the event in more detail. Both the event name and additional properties will be stored with the event and normalized to snake case (project_created and project_name) automatically within Userlist.io.


Personas

You can send computed traits and audiences generated through Segment Personas to this destination as a user property. To learn more about Personas, reach out for a demo.

For user-property destinations, an identify call will be sent to the destination for each user being added and removed. The property name will be the snake_cased version of the audience name you provide with a true/false value. For example, when a user first completes an order in the last 30 days, we will send an identify call with the property order_completed_last_30days: true, and when this user no longer satisfies we will set that value to false.

When the audience is first created an identify call is sent for every user in the audience. Subsequent syncs will only send updates for those users which were added or removed since the last sync.

Settings

Segment lets you change these destination settings via your Segment dashboard without having to touch any code.

API Key

Please enter the token available in your Userlist Push API settings.

Adding Userlist to the integrations object

To add Userlist to the integrations JSON object (for example, to filter data from a specific source), use one of the 1 valid names for this integration:
  • Userlist


  • Questions? Need help? Contact us!
    Can we improve this doc?
    Email us: docs-feedback@segment.com!