Promoter Destination


On this page


Getting Started

Once the Segment library is integrated with your service, add your Promoter API Key and toggle on Promoter in your Segment destinations page. You can find your API key in Promoter.io under Accounts Settings > Segment Destination.


Promoter supports the identify and track methods from Segment and will allow you to:

  • Add a contact to a list
  • Send a survey to a contact

Both identify and track will need to be called in order to utilize the full power of Promoter.

Identify

By calling identify, you will effectively be creating a new contact for your organization.

Within the identify event, Promoter requires a userId and email, while firstName and lastName are optional. However, it is encouraged that you pass in as many attributes that are meaningful to your organization around the context of NPS. You will be able to filter your score by every single attribute or combination of attributes provided.

Here’s an example:

{
  "userId": "12345",
  "action": "identify",
  "traits": {
    "email": "ted@mosbiusdesigns.com",
    "firstName": "Ted",
    "lastName": "Mosby",
    "plan": "Premium"
  }
}

Track

By creating a track event you will effectively trigger a survey to be sent to your contact.

The track event should have an associated userId sent with it. That userId needs to match the userId sent with the identify event. This is the only way we know which contact you would like to associate this event to. We will send a survey to that contact using the campaign that’s associated to Segment within Promoter.

Note: if you are using our client-side javascript library (Analytics.js) and already called identify we will automatically include the userId with every track call.

Here’s an example:

{
  "userId": "12345",
  "action": "identify",
  "traits": {
    "email": "ted@mosbiusdesigns.com",
    "firstName": "Ted",
    "lastName": "Mosby",
    "plan": "Premium"
  }
}

Completed Order

When you track an event with the name Order Completed using the e-commerce tracking API, we will send the event and data to Promoter as a custom event with the data stored with Promoter for future use.

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.

Supported Sources and Connection Modes

The first step is to make sure Promoter.io 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.

Web Mobile Server
📱 Device-mode
☁️ Cloud-mode

To learn more about about Connection Modes and what dictates which we support, see here.

This destination requires a Device-based Connection Mode for Mobile data. Follow the steps above to ensure you have packaged the Promoter.io SDK with Segment’s.

Settings

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

API Key

You can find your API key in Promoter.io under your accounts settings > Segment Integration

Get started with Segment

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