Skip to content

Listrak Actions Destination #5060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions src/_data/catalog/destinations_private.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3337,3 +3337,122 @@ items:
source_ip:
'@path': $.context.ip
trigger: type = "track"
- id: 64b6a221baf168a989be641a
display_name: Listrak (Actions)
name: Listrak (Actions)
slug: listrak-actions
previous_names:
- Listrak (Actions)
url: connections/destinations/catalog/listrak-actions
website: https://www.listrak.com/
status: PRIVATE_BETA
logo:
url: https://cdn.filepicker.io/api/file/4RP5BcSWGEhhlgDPLwxt
mark:
url: https://cdn.filepicker.io/api/file/Ij4RvMdSPeRIf7ishyr1
methods:
track: true
identify: true
group: true
alias: true
screen: false
page: true
platforms:
browser: true
mobile: false
server: true
warehouse: false
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
settings:
- name: client_id
type: string
defaultValue: ''
description: >-
Your Listrak API client ID. Find this on the setup tab of your Segment
integration under Integrations > Integrations Management in
https://admin.listrak.com.
required: true
label: API Client ID
- name: client_secret
type: password
defaultValue: ''
description: >-
Your Lisrak API client secret. Find this on the setup tab of your
Segment integration under Integrations > Integrations Management in
https://admin.listrak.com.
required: true
label: API Client Secret
actions:
- id: tnuEKrJwivx1wQAVeTijxK
name: Update Email Contact Profile Fields
slug: updateEmailContactProfileFields
description: >-
One or more list imports will be started to update the specified
contact profile fields on the specified list.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- id: keB4AueGWBacc9aWiGGaRz
sortOrder: 0
fieldKey: listId
label: List ID
type: INTEGER
description: >-
Identifier used to locate the list. Find this under Help & Support
> API ID Information in https://admin.listrak.com.
placeholder: ''
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: aSQGErWY9GZqyfTr9s4tjB
sortOrder: 1
fieldKey: emailAddress
label: Email Address
type: STRING
description: Email address of the contact.
placeholder: ''
defaultValue:
'@path': $.context.traits.email
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: oErNXoXW43BhfYc9zma9EU
sortOrder: 2
fieldKey: profileFieldValues
label: Profile Field Values
type: OBJECT
description: >-
Add key value pairs to set one or more profile fields. The key is
the profile field ID you want to set. Find this under Help &
Support > API ID Information in https://admin.listrak.com. The
value is the profile field value. (i.e. 1234 = on)
placeholder: ''
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: bFoamMtf1AGGMMjnQz6daY
sortOrder: 3
fieldKey: enable_batching
label: Batch Data to Listrak
type: BOOLEAN
description: >-
When enabled, multiple events will be sent to Listrak in a single
request, which is recommended for optimal performance.
placeholder: ''
defaultValue: true
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
presets: []
61 changes: 61 additions & 0 deletions src/connections/destinations/catalog/actions-listrak/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Listrak (Actions) Destination
id: 64b6a221baf168a989be641a
private: true
hidden: true
---

{% include content/plan-grid.md name="actions" %}

> info ""
> The Listrak Destination is in beta, and Listrak is still developing the destination. To join Listrak's beta program or to give any feedback to help improve the Listrak Destination and its documentation, [let Listrak know](mailto:support@listrak.com).

[Listrak](https://www.listrak.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} 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](mailto:support@listrak.com).

## Getting started

To add the Listrak Actions destination:

1. Set up the [Listrak Source](/docs/connections/sources/catalog/cloud-apps/listrak/) first before connecting to the Listrak Actions Destination. Note the API client ID and client secret after creating the integration in Listrak.
2. From your Segment workspace, go to **Connections > Catalog** and click **Destinations**.
3. Search for **Listrak (Actions)** in the Destinations Catalog and select the destination.
4. Click **Add destination**.
5. Select an existing Source to connect to Listrak (Actions). If you are connecting the destination to an Engage Audience, select the Engage space. Click **Confirm Source**.
6. On the **Settings** tab, name your destination. For example, `Listrak`.
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. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired.
13. Still 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.
14. Repeat steps 9 through 13 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 13.
15. **Enable** both mappings.
16. Go to the **Settings** tab and **Enable** the destination.
17. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
18. Click **Add Destination** and select the Listrak Audience destination.
19. In the settings that appear on the right-hand side, toggle the **Send Track** option on and disable **Send Identify**.
20. Click **Save**.
21. To filter email sends in Listrak using the new audience profile field, see this [help article](https://help.listrak.com/en/articles/3951597-introduction-to-building-filter-2-0-segments){:target="_blank”}.
22. If you want to sync another audience, repeat steps 1 through 20.

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

---