From 252922fbd319a1790c80b7506605065241a10cb6 Mon Sep 17 00:00:00 2001 From: Leonel Sanches <113376080+seg-leonelsanches@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:53:32 -0700 Subject: [PATCH 1/2] Iterable Lists. --- .../catalog/actions-iterable-lists/index.md | 38 +++++++++++++++++++ .../catalog/actions-iterable/index.md | 1 + 2 files changed, 39 insertions(+) create mode 100644 src/connections/destinations/catalog/actions-iterable-lists/index.md diff --git a/src/connections/destinations/catalog/actions-iterable-lists/index.md b/src/connections/destinations/catalog/actions-iterable-lists/index.md new file mode 100644 index 0000000000..ed0f880921 --- /dev/null +++ b/src/connections/destinations/catalog/actions-iterable-lists/index.md @@ -0,0 +1,38 @@ +--- +title: Iterable Lists (Actions) Destination +strat: iterable +hide-boilerplate: true +id: 645babd9362d97b777391326 +hide-dossier: true +--- + +Iterable Lists destination allows users to upload lists of users to Iterable, in the form of audiences. + +## Getting started + +### Prerequisites + +* An Iterable API Key: can be found in your Iterable account under `Settings > API Keys`; +* An [Engage Audience](/docs/engage/audiences/) configured which you can connect to this destination. + +### Connect Iterable Lists to Segment + +1. From the Segment web app, click on **Engage**, then click on **Engage Settings**; +2. Click on **Destinations**, then click on **Add Destination**; +3. Search for **Iterable Lists** and click on it; +4. Click on **Add destination**, then click on **Confirm Source**; +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**; +6. In your audience, on the Destinations panel, click on **Add Destination** and select the Iterable Lists destination you just created; +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; +8. This destination supports the `identify` and `track` methods, having "Audience Entered" and "Audience Exited" as the default events; +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); +10. Click on **Save** to apply the changes, then click on **Add 1 Destination** to save the destination configuration; +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**; +12. Click on **Sync to Iterable Lists** (the only Action available); +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; +14. If needed, you can define Linked Events enrichments under step 2, "Linked Events: enrich event stream with entities"; +15. Under step 3 ("Map Fields"), you can map the event fields to Iterable fields, like `email`, `userId`, and additional fields; +16. Optionally, you can test the mapping by clicking on **Test Mapping**; +17. Click on **Next**; +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. + diff --git a/src/connections/destinations/catalog/actions-iterable/index.md b/src/connections/destinations/catalog/actions-iterable/index.md index cafad4bb25..55ca1d3206 100644 --- a/src/connections/destinations/catalog/actions-iterable/index.md +++ b/src/connections/destinations/catalog/actions-iterable/index.md @@ -1,5 +1,6 @@ --- title: Iterable (Actions) Destination +strat: iterable hide-boilerplate: true id: 645babd9362d97b777391325 hide-dossier: true From 64a4bb6b11a5cd8ad354889c01e2652f073bd43c Mon Sep 17 00:00:00 2001 From: Leonel Sanches <113376080+seg-leonelsanches@users.noreply.github.com> Date: Thu, 5 Dec 2024 14:32:59 -0800 Subject: [PATCH 2/2] Updating docs with the correct destination ID + "How it Works". --- .../catalog/actions-iterable-lists/index.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/src/connections/destinations/catalog/actions-iterable-lists/index.md b/src/connections/destinations/catalog/actions-iterable-lists/index.md index ed0f880921..1bed0a96c2 100644 --- a/src/connections/destinations/catalog/actions-iterable-lists/index.md +++ b/src/connections/destinations/catalog/actions-iterable-lists/index.md @@ -2,11 +2,24 @@ title: Iterable Lists (Actions) Destination strat: iterable hide-boilerplate: true -id: 645babd9362d97b777391326 +id: 66a7c28810bbaf446695d27d hide-dossier: true +engage: true --- -Iterable Lists destination allows users to upload lists of users to Iterable, in the form of audiences. +Iterable Lists destination allows users to upload lists of users to Iterable, in the form of audiences. Iterable Lists feature [is described here](https://support.iterable.com/hc/en-us/articles/115000770906-Adding-Users-and-Creating-Lists). + +This is an Engage Destination, which means it can be used to send data to Iterable Lists from Segment Engage Audiences. + +## How it works + +**Every time you create an audience in Engage and connect it to the Iterable Lists destination, Segment does the following:** + +1. When the audience is created, Segment will create a new list in Iterable with the audience key as the list name; +2. When a user enters the audience, Segment will add the user to the list in Iterable; +3. When a user exits the audience, Segment will remove the user from the list in Iterable. + +{% include content/sync-frequency-note.md %} ## Getting started @@ -35,4 +48,3 @@ Iterable Lists destination allows users to upload lists of users to Iterable, in 16. Optionally, you can test the mapping by clicking on **Test Mapping**; 17. Click on **Next**; 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. -