Skip to content

Commit 82aac13

Browse files
authored
Merge pull request #6886 from segmentio/thomas/listrak
Update Listrak Destination Docs for New Functionality
2 parents 77a3364 + 054a55e commit 82aac13

File tree

5 files changed

+60
-30
lines changed

5 files changed

+60
-30
lines changed
Loading
Loading
Loading
Loading

src/connections/destinations/catalog/actions-listrak/index.md

Lines changed: 60 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,36 +22,66 @@ To add the Listrak Actions destination:
2222
7. In the same section of the **Settings** tab, enter your Listrak API client ID and client secret.
2323
8. Click **Save Changes**.
2424
9. Follow the steps in the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or follow the steps below to Sync an Engage Audience.
25-
10. Enable the destination and click **Save Changes**.
26-
27-
### Sync an Engage Audience
28-
29-
To sync an Engage audience with your Listrak (Actions) destination:
30-
31-
1. Each Engage audience to be synced to Listrak must only include email addresses subscribed to the list. To do this, add a condition to the Engage audience that ensures the custom trait for the list exists (eg. have a Custom Trait listrak_list_12345 exists, where 12345 is the list ID).
32-
2. In Listrak, go to **Contacts > Profile Fields** and click **Create Field Group**.
33-
3. Enter a name for the Profile Field Group (eg. `Engage Audiences`) and Click **Save**.
34-
4. Enter a name for the audience for the **Field Name**.
35-
5. Select **Check Box** for the **Data Type**.
36-
6. Click the **Update** button.
37-
7. Go to **Help & Support > API ID Information** and note the list ID and profile field ID.
38-
8. In Segment, open the previously created Listrak destination.
39-
9. In the **Mappings** tab, click **New Mapping** and select **Update Email Contact Profile Fields**.
40-
10. Under **Select events to map and send**, select **Track** for the **Event Type**.
41-
11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`.
42-
12. Click **Add Condition** and add this condition: **Event Property** `audience_key` is `my_audience` (where `my_audience` is the Audience Key found on the Audience settings page).
43-
13. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired.
44-
14. Under **Select mappings**, in the section for mapping the `Profile Field Values`, enter the profile field ID for the `Enter Key Name` textbox on the right and `on` in the textbox for its value to the left. Click **Save**.
45-
15. Repeat steps 9 through 14 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 14.
46-
16. **Enable** both mappings.
47-
17. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**.
48-
18. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
49-
19. Click **Add Destination** and select the Listrak Audience destination.
50-
20. In the connection settings that appear on the right-hand side, ensure that the toggle to **Send Track** events is _enabled_, and the toggle to **Send Identify** events is _disabled_.
51-
21. Click **Save**.
52-
22. To filter email sends in Listrak using the new audience profile field, see the [help article](https://help.listrak.com/en/articles/3951597-introduction-to-building-filter-2-0-segments){:target="_blank”}.
53-
23. Repeat steps 1 through 21, if you want to sync another audience.
25+
26+
## Syncing an Engage audience to Listrak
27+
28+
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.
29+
30+
For example, when you build the audience, ensure each profile includes a Custom Trait like `listrak_list_12345`, where `12345` is the List ID.
31+
32+
### Listrak configuration
33+
34+
1. In Listrak, navigate to **Contacts > Profile Fields** and click **Create Field Group**.
35+
2. Enter a name for the Profile Field Group (like `Engage Audiences`) and click **Save**.
36+
3. Enter a name for the audience in the **Field Name** field.
37+
4. Select **Check Box** for the **Data Type**.
38+
5. Click **Update**.
39+
6. 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.
40+
41+
### Segment configuration
42+
43+
In Segment, open the Listrak destination you created. Navigate to the **Mappings** tab, click **New Mapping**, and select **Update Email Contact Profile Fields**.
44+
45+
You can configure the "Update Email Contact Profile Fields" mapping in two ways:
46+
47+
1. **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."
48+
2. **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 the `audience_key` boolean value - `true` ("Audience Entered") activates the field, and `false` ("Audience Exited") deactivates it.
49+
50+
### Recommended approach: single mapping for both events
51+
52+
1. 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.
53+
- Set **Event Context** `personas.computation_key` to `my_audience` (where `my_audience` is the Audience Key from the Audience settings page).
54+
55+
![Mapping Subscription](images/subscription1.png)
56+
57+
2. Under **Select mappings**, enter the Listrak List ID and map the email address if `context.traits.email` is not needed.
58+
3. In the **Profile Field Values** section, enter the Listrak Profile Field ID in the `Enter Key Name` textbox on the right, and type `useAudienceKey` in the textbox on the left.
59+
- 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."
60+
61+
62+
![Mapping Subscription](images/mappings1.png)
63+
64+
4. Click **Save** to save the mapping.
65+
66+
### Alternative approach: separate mappings for each event
67+
68+
1. Under **Select events to map and send**, select **Track** for the **Event Type**.
69+
2. Click **Add Condition** and add: **Event Name** is `Audience Entered`.
70+
3. Click **Add Condition** and add: **Event Property** `audience_key` is `my_audience` (where `my_audience` is the Audience Key from the Audience settings page).
71+
72+
![Mapping Subscription](images/subscription2.png)
73+
74+
5. Under **Select mappings**, enter the Listrak List ID and map the email address if `context.traits.email` is not needed.
75+
6. In the **Profile Field Values** section, enter the Listrak Profile Field ID in the `Enter Key Name` textbox on the right, and type `on` in the textbox on the left. This will activate the profile field in Listrak.
76+
77+
![Mapping Subscription](images/mappings2.png)
78+
79+
6. Click **Save** to save the mapping.
80+
7. Repeat the previous steps, substituting `Audience Entered` for `Audience Exited` and `on` for `off`.
81+
82+
## Using Segment audience data in Listrak
83+
84+
To filter email sends in Listrak using the new audience profile field, refer to the [help article](https://help.listrak.com/en/articles/3951597-introduction-to-building-filter-2-0-segments){:target="_blank"}.
5485

5586
{% include components/actions-fields.html %}
5687

57-
---

0 commit comments

Comments
 (0)