You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-iterable-lists/index.md
+24-22Lines changed: 24 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,38 +13,40 @@ This is an [Engage Destination](/docs/engage/using-engage-data/#engage-destinati
13
13
14
14
## How it works
15
15
16
-
**Every time you create an audience in Engage and connect it to the Iterable Lists destination, Segment does the following:**
16
+
When you create an audience in Engage and connect it to the Iterable Lists destination, Segment automatically
17
17
18
-
1.When the audience is created, Segment will create a new list in Iterable with the audience key as the list name;
19
-
2.When a user enters the audience, Segment will add the user to the list in Iterable;
20
-
3.When a user exits the audience, Segment will remove the user from the list in Iterable.
18
+
1.Creates a new list in Iterable using the audience key as the list name.
19
+
2.Adds users to the list in Iterable when they enter the audience.
20
+
3.Removes users from the list in Iterable when they exit the audience.
21
21
22
22
{% include content/sync-frequency-note.md %}
23
23
24
24
## Getting started
25
25
26
26
### Prerequisites
27
27
28
-
* An Iterable API Key: can be found in your Iterable account under `Settings > API Keys`;
29
-
* An [Engage Audience](/docs/engage/audiences/) configured which you can connect to this destination.
28
+
Before you begin, make sure you have:
29
+
30
+
* An Iterable API Key, which you can find in your Iterable account under **Settings > API Keys**;
31
+
* A configured [Engage Audience](/docs/engage/audiences/) that you want to connect to this destination.
30
32
31
33
### Connect Iterable Lists to Segment
32
34
33
-
1. From the Segment web app, click on**Engage**, then click on **Engage Settings**;
34
-
2. Click on **Destinations**, then click on **Add Destination**;
35
-
3. Search for **Iterable Lists** and click on it;
36
-
4. Click on **Add destination**, then click on **Confirm Source**;
37
-
5. Under Basic Settings, enter a name for your destination (for instance "Iterable Lists Prod Space"), your Iterable API Key, enable the destination, and click on **Save**;
35
+
1. From the Segment web app, go to**Engage > Engage Settings**.
36
+
2. Click on **Destinations**, then click on **Add Destination**.
37
+
3. Search for **Iterable Lists** and click on it.
38
+
4. Click on **Add destination**, then click on **Confirm Source**.
39
+
5. Under Basic Settings, enter a name for your destination (for instance, "Iterable Lists Prod Space"), your Iterable API Key, enable the destination, and click on **Save**.
38
40
6. In your audience, on the Destinations panel, click on **Add Destination** and select the Iterable Lists destination you just created;
39
-
7. Additional configurations can be provided in the destination settings, such as the Campaign ID, whether the unsubscribe operation is global, and whether only existing users can be updated in the list;
40
-
8. This destination supports the `identify` and `track` methods, having "Audience Entered" and "Audience Exited" as the default events;
41
-
9. This destination also supports a default setup (where `email` is considered as the primary identifier) or a custom setup (where you can define the primary identifier and additional fields to be sent to Iterable);
42
-
10. Click on **Save** to apply the changes, then click on **Add 1 Destination** to save the destination configuration;
43
-
11. Iterable Lists will be listed under Destinations table with 0 mappings. Click on the **Add mapping** button, that will open a side modal. On the side modal, click on **Add mapping**;
44
-
12. Click on **Sync to Iterable Lists** (the only Action available);
45
-
13. Under "Define event trigger", make sure to select the event the the proper conditions defined in the Destination Settings in the Audience, that will trigger the audience upload to Iterable Lists. It's a good practice to define a test event for the next mapping steps and testing;
46
-
14. If needed, you can define Linked Events enrichments under step 2, "Linked Events: enrich event stream with entities";
47
-
15. Under step 3 ("Map Fields"), you can map the event fields to Iterable fields, like `email`, `userId`, and additional fields;
48
-
16. Optionally, you can test the mapping by clicking on **Test Mapping**;
49
-
17. Click on **Next**;
41
+
7. Additional configurations can be provided in the destination settings, such as the Campaign ID, whether the unsubscribe operation is global, and whether only existing users can be updated in the list.
42
+
8. This destination supports the Identify and Tracks methods, having `Audience Entered` and `Audience Exited` as the default events.
43
+
9. This destination also supports a default setup (where `email` is considered as the primary identifier) or a custom setup (where you can define the primary identifier and additional fields to be sent to Iterable).
44
+
10. Click on **Save** to apply the changes, then click on **Add 1 Destination** to save the destination configuration.
45
+
11. Iterable Lists will appear under the Destinations table with 0 mappings. Click on the **Add mapping** button, that will open a side modal. On the side modal, click on **Add mapping**.
46
+
12. Click on **Sync to Iterable Lists** (the only Action available).
47
+
13. Under "Define event trigger", make sure to select the event the the proper conditions defined in the Destination Settings in the Audience, that will trigger the audience upload to Iterable Lists. It's a good practice to define a test event for the next mapping steps and testing.
48
+
14. If needed, you can define Linked Events enrichments under step 2, "Linked Events: enrich event stream with entities".
49
+
15. Under step 3 ("Map Fields"), you can map the event fields to Iterable fields, like `email`, `userId`, and additional fields.
50
+
16. Optionally, you can test the mapping by clicking on **Test Mapping**.
51
+
17. Click **Next**.
50
52
18. Under the last step ("Settings"), give this mapping a name, and click on **Save and enable**, if you want to enable the mapping right away, or **Save**, if you want to enable it later.
0 commit comments