diff --git a/src/connections/destinations/catalog/actions-listrak/images/mappings1.png b/src/connections/destinations/catalog/actions-listrak/images/mappings1.png new file mode 100644 index 0000000000..552067cdd4 Binary files /dev/null and b/src/connections/destinations/catalog/actions-listrak/images/mappings1.png differ diff --git a/src/connections/destinations/catalog/actions-listrak/images/mappings2.png b/src/connections/destinations/catalog/actions-listrak/images/mappings2.png new file mode 100644 index 0000000000..a7f5f1cfb2 Binary files /dev/null and b/src/connections/destinations/catalog/actions-listrak/images/mappings2.png differ diff --git a/src/connections/destinations/catalog/actions-listrak/images/subscription1.png b/src/connections/destinations/catalog/actions-listrak/images/subscription1.png new file mode 100644 index 0000000000..c7e4c39408 Binary files /dev/null and b/src/connections/destinations/catalog/actions-listrak/images/subscription1.png differ diff --git a/src/connections/destinations/catalog/actions-listrak/images/subscription2.png b/src/connections/destinations/catalog/actions-listrak/images/subscription2.png new file mode 100644 index 0000000000..4386a93ed4 Binary files /dev/null and b/src/connections/destinations/catalog/actions-listrak/images/subscription2.png differ diff --git a/src/connections/destinations/catalog/actions-listrak/index.md b/src/connections/destinations/catalog/actions-listrak/index.md index 40ef2f72b0..40ff578cd3 100644 --- a/src/connections/destinations/catalog/actions-listrak/index.md +++ b/src/connections/destinations/catalog/actions-listrak/index.md @@ -22,36 +22,66 @@ To add the Listrak Actions destination: 7. In the same section of the **Settings** tab, enter your Listrak API client ID and client secret. 8. Click **Save Changes**. 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. -10. Enable the destination and click **Save Changes**. - -### Sync an Engage Audience - -To sync an Engage audience with your Listrak (Actions) destination: - -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). -2. In Listrak, go to **Contacts > Profile Fields** and click **Create Field Group**. -3. Enter a name for the Profile Field Group (eg. `Engage Audiences`) and Click **Save**. -4. Enter a name for the audience for the **Field Name**. -5. Select **Check Box** for the **Data Type**. -6. Click the **Update** button. -7. Go to **Help & Support > API ID Information** and note the list ID and profile field ID. -8. In Segment, open the previously created Listrak destination. -9. In the **Mappings** tab, click **New Mapping** and select **Update Email Contact Profile Fields**. -10. Under **Select events to map and send**, select **Track** for the **Event Type**. -11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`. -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). -13. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired. -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**. -15. Repeat steps 9 through 14 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 14. -16. **Enable** both mappings. -17. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**. -18. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination. -19. Click **Add Destination** and select the Listrak Audience destination. -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_. -21. Click **Save**. -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ā€}. -23. Repeat steps 1 through 21, if you want to sync another 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 + +1. In Listrak, navigate to **Contacts > Profile Fields** and click **Create Field Group**. +2. Enter a name for the Profile Field Group (like `Engage Audiences`) and click **Save**. +3. Enter a name for the audience in the **Field Name** field. +4. Select **Check Box** for the **Data Type**. +5. Click **Update**. +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. + +### 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: + +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." +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. + +### Recommended approach: single mapping for both events + +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. +- Set **Event Context** `personas.computation_key` to `my_audience` (where `my_audience` is the Audience Key from the Audience settings page). + + ![Mapping Subscription](images/subscription1.png) + +2. Under **Select mappings**, enter the Listrak List ID and map the email address if `context.traits.email` is not needed. +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. +- 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." + + + ![Mapping Subscription](images/mappings1.png) + +4. Click **Save** to save the mapping. + +### Alternative approach: separate mappings for each event + +1. Under **Select events to map and send**, select **Track** for the **Event Type**. +2. Click **Add Condition** and add: **Event Name** is `Audience Entered`. +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). + + ![Mapping Subscription](images/subscription2.png) + +5. Under **Select mappings**, enter the Listrak List ID and map the email address if `context.traits.email` is not needed. +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. + + ![Mapping Subscription](images/mappings2.png) + +6. Click **Save** to save the mapping. +7. Repeat the previous steps, substituting `Audience Entered` for `Audience Exited` and `on` for `off`. + +## Using Segment audience data in Listrak + +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"}. {% include components/actions-fields.html %} ----