Skip to content

Commit 1651b43

Browse files
authored
Merge pull request #5060 from segmentio/listrak/add-destination-documentation
Listrak Actions Destination
2 parents 4d72979 + 9ab842e commit 1651b43

File tree

2 files changed

+180
-0
lines changed

2 files changed

+180
-0
lines changed

src/_data/catalog/destinations_private.yml

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3337,3 +3337,122 @@ items:
33373337
source_ip:
33383338
'@path': $.context.ip
33393339
trigger: type = "track"
3340+
- id: 64b6a221baf168a989be641a
3341+
display_name: Listrak (Actions)
3342+
name: Listrak (Actions)
3343+
slug: listrak-actions
3344+
previous_names:
3345+
- Listrak (Actions)
3346+
url: connections/destinations/catalog/listrak-actions
3347+
website: https://www.listrak.com/
3348+
status: PRIVATE_BETA
3349+
logo:
3350+
url: https://cdn.filepicker.io/api/file/4RP5BcSWGEhhlgDPLwxt
3351+
mark:
3352+
url: https://cdn.filepicker.io/api/file/Ij4RvMdSPeRIf7ishyr1
3353+
methods:
3354+
track: true
3355+
identify: true
3356+
group: true
3357+
alias: true
3358+
screen: false
3359+
page: true
3360+
platforms:
3361+
browser: true
3362+
mobile: false
3363+
server: true
3364+
warehouse: false
3365+
components: []
3366+
browserUnbundlingSupported: false
3367+
browserUnbundlingPublic: false
3368+
replay: false
3369+
settings:
3370+
- name: client_id
3371+
type: string
3372+
defaultValue: ''
3373+
description: >-
3374+
Your Listrak API client ID. Find this on the setup tab of your Segment
3375+
integration under Integrations > Integrations Management in
3376+
https://admin.listrak.com.
3377+
required: true
3378+
label: API Client ID
3379+
- name: client_secret
3380+
type: password
3381+
defaultValue: ''
3382+
description: >-
3383+
Your Lisrak API client secret. Find this on the setup tab of your
3384+
Segment integration under Integrations > Integrations Management in
3385+
https://admin.listrak.com.
3386+
required: true
3387+
label: API Client Secret
3388+
actions:
3389+
- id: tnuEKrJwivx1wQAVeTijxK
3390+
name: Update Email Contact Profile Fields
3391+
slug: updateEmailContactProfileFields
3392+
description: >-
3393+
One or more list imports will be started to update the specified
3394+
contact profile fields on the specified list.
3395+
platform: CLOUD
3396+
hidden: false
3397+
defaultTrigger: null
3398+
fields:
3399+
- id: keB4AueGWBacc9aWiGGaRz
3400+
sortOrder: 0
3401+
fieldKey: listId
3402+
label: List ID
3403+
type: INTEGER
3404+
description: >-
3405+
Identifier used to locate the list. Find this under Help & Support
3406+
> API ID Information in https://admin.listrak.com.
3407+
placeholder: ''
3408+
required: true
3409+
multiple: false
3410+
choices: null
3411+
dynamic: false
3412+
allowNull: false
3413+
- id: aSQGErWY9GZqyfTr9s4tjB
3414+
sortOrder: 1
3415+
fieldKey: emailAddress
3416+
label: Email Address
3417+
type: STRING
3418+
description: Email address of the contact.
3419+
placeholder: ''
3420+
defaultValue:
3421+
'@path': $.context.traits.email
3422+
required: true
3423+
multiple: false
3424+
choices: null
3425+
dynamic: false
3426+
allowNull: false
3427+
- id: oErNXoXW43BhfYc9zma9EU
3428+
sortOrder: 2
3429+
fieldKey: profileFieldValues
3430+
label: Profile Field Values
3431+
type: OBJECT
3432+
description: >-
3433+
Add key value pairs to set one or more profile fields. The key is
3434+
the profile field ID you want to set. Find this under Help &
3435+
Support > API ID Information in https://admin.listrak.com. The
3436+
value is the profile field value. (i.e. 1234 = on)
3437+
placeholder: ''
3438+
required: true
3439+
multiple: false
3440+
choices: null
3441+
dynamic: false
3442+
allowNull: false
3443+
- id: bFoamMtf1AGGMMjnQz6daY
3444+
sortOrder: 3
3445+
fieldKey: enable_batching
3446+
label: Batch Data to Listrak
3447+
type: BOOLEAN
3448+
description: >-
3449+
When enabled, multiple events will be sent to Listrak in a single
3450+
request, which is recommended for optimal performance.
3451+
placeholder: ''
3452+
defaultValue: true
3453+
required: true
3454+
multiple: false
3455+
choices: null
3456+
dynamic: false
3457+
allowNull: false
3458+
presets: []
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Listrak (Actions) Destination
3+
id: 64b6a221baf168a989be641a
4+
private: true
5+
hidden: true
6+
---
7+
8+
{% include content/plan-grid.md name="actions" %}
9+
10+
> info ""
11+
> 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:[email protected]).
12+
13+
[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.
14+
15+
Listrak maintains this destination. For any issues with the destination, [contact the Listrak Support team](mailto:[email protected]).
16+
17+
## Getting started
18+
19+
To add the Listrak Actions destination:
20+
21+
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.
22+
2. From your Segment workspace, go to **Connections > Catalog** and click **Destinations**.
23+
3. Search for **Listrak (Actions)** in the Destinations Catalog and select the destination.
24+
4. Click **Add destination**.
25+
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**.
26+
6. On the **Settings** tab, name your destination. For example, `Listrak`.
27+
7. In the same section of the **Settings** tab, enter your Listrak API client ID and client secret.
28+
8. Click **Save Changes**.
29+
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.
30+
10. Enable the destination and click **Save Changes**.
31+
32+
### Sync an Engage Audience
33+
34+
To sync an Engage audience with your Listrak (Actions) destination:
35+
36+
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).
37+
2. In Listrak, go to **Contacts > Profile Fields** and click **Create Field Group**.
38+
3. Enter a name for the Profile Field Group (eg. `Engage Audiences`) and Click **Save**.
39+
4. Enter a name for the audience for the **Field Name**.
40+
5. Select **Check Box** for the **Data Type**.
41+
6. Click the **Update** button.
42+
7. Go to **Help & Support > API ID Information** and note the list ID and profile field ID.
43+
8. In Segment, open the previously created Listrak destination.
44+
9. In the **Mappings** tab, click **New Mapping** and select **Update Email Contact Profile Fields**.
45+
10. Under **Select events to map and send**, select **Track** for the **Event Type**.
46+
11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`.
47+
12. Under **Select mappings**, enter the list ID and map the email address if `context.traits.email` is not desired.
48+
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.
49+
14. Repeat steps 9 through 13 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 13.
50+
15. **Enable** both mappings.
51+
16. Go to the **Settings** tab and **Enable** the destination.
52+
17. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
53+
18. Click **Add Destination** and select the Listrak Audience destination.
54+
19. In the settings that appear on the right-hand side, toggle the **Send Track** option on and disable **Send Identify**.
55+
20. Click **Save**.
56+
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”}.
57+
22. If you want to sync another audience, repeat steps 1 through 20.
58+
59+
{% include components/actions-fields.html %}
60+
61+
---

0 commit comments

Comments
 (0)