Extole Destination


Brands use Extole to turn customers into advocates. Our enterprise platform and team of experts create beautiful referral and customer engagement programs, so brands can harness the power of sharing to the benefit of their bottom line. Extole enables marketers to engage thousands of advocates, scaling word-of-mouth to acquire new customers and increase loyalty using their greatest competitive advantage: their customers.

This destination is maintained by Extole. For any issues with the destination, please reach out to Extole Support.

Getting Started

  1. Go to your Extole Tech Center page and generate an API Key. Copy that key. If you encounter any problems, check this Extole Help Page on access tokens.
  2. From the Segment Destinations page, click Add Destination.
  3. Search for “Extole Platform” in the Destinations Catalog, and select it.
  4. Confirm which Source to connect to Extole.
  5. Enter the Extole “API Key” in your Segment Settings UI.

Identify

If you haven’t had a chance to review our spec, please take a look to understand what the Identify method does. Identify calls are sent to Extole as an identify event. Segment sends Identify calls to Extole as an identify event. Extole creates a new profile or updates an existing one. The table below lists how the basic traits are mapped:

Segment Traits Extole Properties
userId partner_user_id
email email
firstName first_name
lastName last_name

Note: All non-standard traits will be added to Extole user profile as PUBLIC parameters.

An example of .identify() call:

analytics.identify('userId123', {
  email: 'john.doe@example.com',
  firstName: 'John',
  lastName: 'Doe',
  age: 25,
  existingCustomer: true
});

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('Login Button Clicked')

Track calls are sent to Extole as a track event.

Track Registrations

Track when a user creates a new account. The example below shows a track event with an event name of registration.

analytics.track('registration', {
    email: 'john.doe@example.com',
    first_name: 'John',
    last_name: 'Doe',
    partner_user_id: 'userId123'
})

Extole recommends that you send the partner_user_id with every call. If an event is fired multiple times for the same user, Extole de-duplicates it.

Track Conversions

Track when a user performs a purchase.

analytics.track('conversion', {
    email: 'john.doe@example.com',
    first_name: 'John',
    last_name: 'Doe',
    partner_conversion_id: 'purchaseId123',
    cart_value: '99.99'
})

Extole recommends that you send the partner_conversion_id with every call. If an event is fired multiple times for the same user, Extole de-duplicates it.

Event Names

If you do not use the event names registration and conversion in your implementation, contact Extole Support and Extole can re-map these events to any other event names.

Delete

To make consumer data deletion requests more seamless, Extole handles deletion requests.

Example of expected delete request body:

{
    "userId": "056tf9eqw24"
}

Upon receiving a deletion request, Extole removes all data associated with that user.

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 from your Segment dashboard without having to touch any code.

API Key

You can create an API key by following this help article

This page was last modified: 27 Apr 2020

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