Listrak
Set up a connection between your Extole programs and Listrak's cross-channel marketing platform.
Overview
Listrak is an industry-leading cross-channel marketing platform that delivers results for more than 1,000 retailers by providing best-in-class email, SMS, behavioral marketing, cross-channel orchestration, predictive analytics, and customer insight solutions that drive customer engagement, revenue, and loyalty.
With the integration between Extole and Listrak, you can send valuable customer data from your Refer A Friend and growth programs directly into Listrak to send messages at precisely the right time across the right combination of channels and devices to maximize customer engagement, revenue, and lifetime value.
Prerequisites
Requirement | Description |
---|---|
Listrak Account | A Listrak account is required in order to take advantage of this partnership. |
Listrak Client ID and Client Secret | A Listrak Client ID and Client secret can be created within the Listrak > Manage > Integrations > New Integration. Make sure to securely store a copy of your Client ID and Client Secret. These values will be needed to authenticate with the Listrak Email API. For your security, the Client Secret cannot be retrieved if it is lost. |
List ID(s) | The List ID(s) users will be subscribed to for opting in. To find your IDs within Listrak, go to Contacts > List Manager > Select the desired List > Select Help and Support in the Left Navigation > Select API ID Information. |
Segmentation Field ID(s) optional | The Segmentation Field IDs of any data other than email (e.g., first name, last name, phone number, etc.) that you want sent to your list in Listrak. |
Use Case
Create new audiences using insights from your advocacy campaigns to grow your email and SMS list. When advocates and friends opt-in to marketing communications in your refer-a-friend program, Extole will automatically send email addresses, phone numbers, and other attributes, such as an advocate’s unique share link, into Listrak.
Integration
Complete the following steps to set up your integration with Listrak.
Enable API Access in Listrak
To enable API access, you must create an Integration on the Integrations page. In the Listrak application on the navigation bar, go to Manage > Integrations Manager.
Please specify integration type Email for your integration. You must also specify which areas of the API should be made accessible. Available areas include:
- Contact
- Event
- List
- Message
- Reporting
- Segmentation
Make sure to securely store a copy of your Client ID and Client Secret. These values will be needed to authenticate with the API. For your security, the Client Secret cannot be retrieved if it is lost.
Define User Attributes (Optional)
When sending email or SMS marketing opt-ins from Extole to Listrak, you have the option to add user attributes which can be used for segmentation within the Listrak Journey Hub. If you would like to send additional attributes from Extole to Listrak, you must configure additional Segmentation Field IDs in Listrak. Below are several examples of common user attributes. Please work with your client success or implementation manager at Extole and Listrak to configure the proper user attributes and Segmentation Field IDs in each platform.
Attribute Name | Description |
---|---|
email required | The customer's email address E.g., [email protected] |
phone_number | The customer's phone number, including country code E.g., +15555555555 |
share_link | The customer’s personal share link E.g., refer.yourcompany.com/jsmith |
first_name | The customer's first name E.g., John |
last_name | The customer's last name E.g., Smith |
city | The customer's city, spelled out E.g., Boston |
state | The customer's state, abbreviated E.g., MA |
country | The customer's country, abbreviated E.g., US |
funnel | The correct funnel for the customer E.g. friend and/or advocate |
If you would like to send custom events into Listrak for different actions that users are taking in your Extole-powered programs, please refer to the Customization section of this document.
Connect to Your Listrak Account
To start sending data from your Extole programs into your Listrak account, you will need to set up an outbound webhook in the My Extole Tech Center. This type of webhook authentication is accomplished using the OAUTH_LISTRAK
key type.
In My Extole, start by navigating to the Tech Center > Outbound Webhooks > + New Integration. Enter the following information:
- Key Name: How you’d like to refer to the key in Extole
- Partner Key ID: A unique identifier defined by you
- Key Type: Webhook
- Algorithm:
OAUTH_LISTRAK
- Key: Your Listrak Client Secret
- Client ID: Your Listrak Client ID
- Authorization URL: https://auth.listrak.com/OAuth2/Token
- Scope: You can leave this field blank
Click the Create Key button to finish.
Send Data from Extole to Listrak
Work with your client success or implementation manager at Extole to create a new outbound webhook in your My Extole account. Your team will configure the webhook for you and Extole Support will finalize the connection. As an example, for sending opt-ins to Listrak, Extole will set up the webhook to point to Listrak’s Email API endpoint /v1/List/{listId}/Contact.
Customization
Configure a Staging API Key for Testing
If you only provide one Listrak REST API key to Extole, only production events will be sent. If you also want to send staging or testing events, create another Listrak REST API key and configure a new webhook integration in your My Extole Tech Center.
Send Custom Events
Any event that Extole tracks can be sent to Listrak as a custom event. Please work with your Extole and Listrak implementation or client success manager to identify the event names and attributes that you’d like for Extole to send into Listrak, or select from the examples below.
Event Name | Description |
---|---|
Created Share Link | A share link is created for a customer. |
Shared | A customer sends a link to their friend(s) via email, SMS, or social channel. |
Referred Signed Up | A referred customer signs up via email or SMS through the program. |
Referred Converted | A referred customer completes a purchase. Please note that outcome events can be customized for your business. |
Reward Earned | A customer earns a reward. |
Example use case
You may decide you want to send profile data updates (e.g., changes to first name, last name, etc.) to Listrak. Depending on where your campaign is managed in Listrak, setting up this custom event will look different.
If your Listrak campaign is managed in Conductor, you would still use the create or update a contact call in the Email API and add the ?eventIds parameter with the IDs of the events that are being fired. (e.g., https://api.listrak.com/email/v1/List/{listId}/Contact?eventIDs=123456).
If your Listrak campaign is managed in Journey Hub, you will need to set up a new integration using Listrak's Cross Channel REST API and fire a custom event using this post new custom event call. In this case, the custom event can also include custom data to be used for filtering within the Journey, but will not be saved to the contact's profile fields. For more information, reference Listrak’s Help Center Guide: Custom Events.
Using this Integration
Once you have created the integration key and your webhook has been configured by your team, Extole Support will test and finalize your connection. At this point, you will be able to see events flowing to Listrak in the Webhook Live View on the Outbound Webhooks page of My Extole.
Once the events and attributes are flowing into Listrak, you can use them to generate Listrak audiences and segments.
Updated 12 months ago