Listrak (Actions) Destination
Listrak is the retail industry’s leading customer engagement platform. Listrak delivers results for more than 1,000 retailers by providing best-in-class email, text message marketing, identity resolution marketing and push notifications through seamless cross-channel orchestration. Listrak’s data-first approach delivers 1:1 personalization at scale so you can send messages at precisely the right time across the right combination of channels and devices to maximize customer engagement, revenue, and lifetime value.
Listrak maintains this destination. For any issues with the destination, contact the Listrak Support team.
Getting started
To add the Listrak Actions destination:
- Set up the Listrak Source first before connecting to the Listrak Actions Destination. Note the API client ID and client secret after creating the integration in Listrak.
- From your Segment workspace, go to Connections > Catalog and select the Destinations tab.
- Search for Listrak (Actions) in the Catalog and select the destination.
- Click Add destination.
- On the Select data source step, select your desired source. The source should not be a Listrak source. If you want to sync an Engage Audience, select the Engage space as the source. Click Confirm Source.
- On the Settings tab, name your destination. For example,
Listrak
. - In the same section of the Settings tab, enter your Listrak API client ID and client secret.
- Click Save Changes.
- Follow the steps in the Destinations Actions documentation to customize mappings or follow the steps below to Sync an Engage Audience.
Syncing an Engage audience to Listrak
To sync an Engage audience with Listrak (Actions), first ensure that the Engage audience only includes profiles with email addresses subscribed to the Listrak list.
For example, when you build the audience, ensure each profile includes a Custom Trait like listrak_list_12345
, where 12345
is the List ID.
Listrak configuration
- In Listrak, navigate to Contacts > Profile Fields and click Create Field Group.
- Enter a name for the Profile Field Group (like
Engage Audiences
) and click Save. - Enter a name for the audience in the Field Name field.
- Select Check Box for the Data Type.
- Click Update.
- Go to Help & Support > API ID Information and note the List ID and Profile Field ID values. You’ll use these in your Segment destination.
Segment configuration
In Segment, open the Listrak destination you created. Navigate to the Mappings tab, click New Mapping, and select Update Email Contact Profile Fields.
You can configure the “Update Email Contact Profile Fields” mapping in two ways:
- Separate Mappings: Create individual mappings for “Audience Entered” and “Audience Exited” events. Set the profile field to “on” for “Audience Entered” and “off” for “Audience Exited.”
- Single Mapping: Use one mapping with the special value
useAudienceKey
for the profile field. This will dynamically use “on” and “off” in the request made to Listrak based on theaudience_key
boolean value -true
(“Audience Entered”) activates the field, andfalse
(“Audience Exited”) deactivates it.
Recommended approach: single mapping for both events
- To use a single mapping for “Audience Entered” and “Audience Exited” events, under Select events to map and send, configure a condition to include events from the desired audience only.
- Set Event Context
personas.computation_key
tomy_audience
(wheremy_audience
is the Audience Key from the Audience settings page).
- Set Event Context
- Under Select mappings, enter the Listrak List ID and map the email address if
context.traits.email
is not needed. - In the Profile Field Values section, enter the Listrak Profile Field ID in the
Enter Key Name
textbox on the right, and typeuseAudienceKey
in the textbox on the left.- This configuration will activate the profile field based on the boolean value in the Audience payload: “true” activates the field for “Audience Entered,” and “false” deactivates it for “Audience Exited.”
- Click Save to save the mapping.
Alternative approach: separate mappings for each event
- Under Select events to map and send, select Track for the Event Type.
- Click Add Condition and add: Event Name is
Audience Entered
. -
Click Add Condition and add: Event Property
audience_key
ismy_audience
(wheremy_audience
is the Audience Key from the Audience settings page). - Under Select mappings, enter the Listrak List ID and map the email address if
context.traits.email
is not needed. -
In the Profile Field Values section, enter the Listrak Profile Field ID in the
Enter Key Name
textbox on the right, and typeon
in the textbox on the left. This will activate the profile field in Listrak. - Click Save to save the mapping.
- Repeat the previous steps, substituting
Audience Entered
forAudience Exited
andon
foroff
.
Using Segment audience data in Listrak
To filter email sends in Listrak using the new audience profile field, refer to the help article.
Destination Settings
Setting | Description |
---|---|
API Client ID | Required. Your Listrak API client ID. Find this on the setup tab of your Segment integration under Integrations > Integrations Management in https://admin.listrak.com. |
API Client Secret | Required. Your Lisrak API client secret. Find this on the setup tab of your Segment integration under Integrations > Integrations Management in https://admin.listrak.com. |
Available Actions
Build your own Mappings. Combine supported triggers with the following Listrak-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
Update Email Contact Profile Fields
One or more list imports will be started to update the specified contact profile fields on the specified list.
Update Email Contact Profile Fields is a Cloud action.
Field | Description |
---|---|
List ID* | Type: INTEGER Identifier used to locate the list. Find this under Help & Support > API ID Information in https://admin.listrak.com. |
Email Address* | Type: STRING Email address of the contact. |
Profile Field Values* | Type: OBJECT Add one or more profile field IDs as object keys. You can find these IDs under Help & Support > API ID Information on https://admin.listrak.com. Choose one of three options as the object value: “on” (activates this field in Listrak), “off” (deactivates this field in Listrak), or “useAudienceKey” (Listrak sets the field based on the Segment Audience payload’s audience_key boolean value: “true” activates the field, “false” deactivates it). |
Batch Data to Listrak* | Type: BOOLEAN When enabled, multiple events will be sent to Listrak in a single request, which is recommended for optimal performance. |
Engage
You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.
For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true
. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false
.
When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.
Real-time to batch destination sync frequency
Real-time audience syncs to Listrak (Actions) may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.
Settings
Segment lets you change these destination settings from the Segment app without having to touch any code.
Setting | Description |
---|---|
API Client ID (required) |
string . Your Listrak API client ID. Find this on the setup tab of your Segment integration under Integrations > Integrations Management in https://admin.listrak.com. |
API Client Secret (required) |
password . Your Lisrak API client secret. Find this on the setup tab of your Segment integration under Integrations > Integrations Management in https://admin.listrak.com. |
This page was last modified: 01 Aug 2024
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!