Skip to content

Commit 6f3838b

Browse files
authored
Merge pull request #5082 from listrak/listrak/update-documentation
Listrak/update documentation
2 parents 88729fb + f810b28 commit 6f3838b

File tree

2 files changed

+55
-23
lines changed
  • src/connections
    • destinations/catalog/actions-listrak
    • sources/catalog/cloud-apps/listrak

2 files changed

+55
-23
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Listrak maintains this destination. For any issues with the destination, [contac
1919
To add the Listrak Actions destination:
2020

2121
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.
22+
2. From your Segment workspace, go to **Connections > Catalog** and select the **Destinations** tab.
23+
3. Search for **Listrak (Actions)** in the Catalog and select the destination.
2424
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**.
25+
5. 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**.
2626
6. On the **Settings** tab, name your destination. For example, `Listrak`.
2727
7. In the same section of the **Settings** tab, enter your Listrak API client ID and client secret.
2828
8. Click **Save Changes**.
@@ -45,10 +45,10 @@ To sync an Engage audience with your Listrak (Actions) destination:
4545
10. Under **Select events to map and send**, select **Track** for the **Event Type**.
4646
11. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered`.
4747
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.
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. Click **Save**.
4949
14. Repeat steps 9 through 13 using `Audience Exited` instead of `Audience Entered` in step 11 and `off` instead of `on` in step 13.
5050
15. **Enable** both mappings.
51-
16. Go to the **Settings** tab and **Enable** the destination.
51+
16. Go to the **Settings** tab for the destination and **Enable** the destination. Click **Save Changes**.
5252
17. Select the Engage space and navigate to **Engage > Audiences**. Select the source audience to send to the Listrak destination.
5353
18. Click **Add Destination** and select the Listrak Audience destination.
5454
19. In the settings that appear on the right-hand side, toggle the **Send Track** option on and disable **Send Identify**.

src/connections/sources/catalog/cloud-apps/listrak/index.md

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,56 @@ This source is maintained by Listrak. For any issues with the source, [contact t
2323

2424
4. Click **Add Source** to save your settings.
2525
5. Copy the Write key from the Segment UI.
26-
6. Log in to your [Listrak account](https://admin.listrak.com){:target="_blank"}, and navigate to Integrations > Integrations Management.
27-
6. Click **New Integration**.
28-
7. Click the Segment card
29-
8. Click Setup Integration
30-
9. Paste the Write key you copied from Segment and click **Save**.
31-
10. Add at least one email list that you want to sync with Segment and click **Save**.
32-
33-
## Components
34-
35-
**Stream**
36-
37-
Listrak uses our stream Source component to send Segment event data. It uses a server-side `identify` method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
38-
39-
Listrak always sets the `anonymousId` and the `email` trait to the email address of the contact.
40-
41-
If a profile field was entered when the email list was added to the integration and the email address has a value for that profile field, the `userId` will be set to that value. Otherwise, Listrak will not set the `userId`.
42-
43-
Listrak maintains a trait for each email list you add to the integration. The trait is named `Listrak_list_{listId}`, where `{listId}` is the ID of the list (eg. `Listrak_list_12345`). The trait will be set to true if the email address is subscribed to the list. The trait will be removed if the email address is not subscribed to the list. This trait can be used to create Engage audiences that only contain profiles that are subscribed to a Listrak list.
26+
6. If using Unify and Engage Audiences:
27+
1. Go to Unify > Unify settings > Profile sources
28+
2. Click **Connect source**
29+
3. Select the new Listrak source
30+
4. Click **Connect source**
31+
7. Log in to your [Listrak account](https://admin.listrak.com){:target="_blank"}, and navigate to Integrations > Integrations Management.
32+
8. Click **New Integration**.
33+
9. Click the Segment card
34+
10. Click Setup Integration
35+
11. Paste the Write key you copied from Segment and click **Save**.
36+
12. Add at least one email list that you want to sync with Segment and click **Save**.
37+
38+
## Stream
39+
40+
Listrak uses Segment's stream Source component to send Segment event data. It uses the server-side `identify` and `track` methods to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
41+
42+
Listrak sets the `anonymousId` and the `email` trait to the email address of the contact.
43+
44+
If you entered a profile field when the email list was added to the integration and the email address has a value for that profile field, the `userId` is set to that value when you send identify events. Otherwise, Listrak won't send the `userId`. The `userId` won't be set for any `track` events.
45+
Listrak maintains a trait for each email list you add to the integration using `identify` events. The trait is named `listrak_list_{listId}`, where `{listId}` is the ID of the list (eg. `listrak_list_12345`). The trait will be set to true if the email address is subscribed to the list. The trait will be removed if the email address is not subscribed to the list. This trait can be used to create Engage audiences that only contain profiles that are subscribed to a Listrak list.
46+
47+
## Events
48+
49+
The table below lists events that Listrak sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations.
50+
51+
Event Name | Description
52+
------------ | -------------
53+
Email Opened | The recipient opened the email.
54+
Email Link Clicked | The recipient clicked on a link in the email's body.
55+
Email Bounced | The email servers rejected the email.
56+
Email Converted | The recipient placed an order after clicking on the email.
57+
58+
## Event Properties
59+
60+
The table below lists the properties included in the events listed above.
61+
62+
Property Name | Description
63+
--------------- | ------------
64+
`email_id`| An ID used to identify the email.
65+
`email_subject`| The email’s subject line.
66+
`campaign_name`| A name used to identify a Listrak campaign.
67+
`link_id` | An ID used to identify a link.
68+
`link_url` | The URL the link points to.
69+
`google_analytics_campaign_name` | A name used to identify a Google Analytics campaign.
70+
`list_id` | An ID used to identify a list.
71+
`list_name` | A name used to identify a list.
72+
`order_total` | The order total associated with the conversion.
73+
`context.ip` | The opening computer’s public IP address.
74+
`context.traits.email` | The intended recipient’s email address.
75+
`context.user_agent` | The opening browser’s user agent.
4476

4577
## Adding Destinations
4678

0 commit comments

Comments
 (0)