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/engage/audiences/linked-audiences-iterable.md
+44-21Lines changed: 44 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,8 @@ beta: true
5
5
hidden: true
6
6
---
7
7
8
-
Linked Audiences allows you to [dynamically personalize email messages](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars) in Iterable using the predefined traits of any Linked Audience profile and the attributes of any entities used to match the profile into the audience.
8
+
9
+
Linked Audiences allows you to [dynamically personalize email messages](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars) in Iterable using the predefined traits of any Linked Audience profile and the attributes of any entities used to match the profile into the audience.
9
10
10
11
The following topic is intended for a Technical Marketer and Data Engineer to complete together while setting up their Linked Audience.
11
12
@@ -32,24 +33,22 @@ You can configure multiple triggers per audience (For example: one for account e
32
33
33
34
Iterable [Journey Campaigns](https://support.iterable.com/hc/en-us/articles/360050203812-Campaigns-Overview#journey-campaigns) store the entity personalization payload as [event properties in custom events](https://support.iterable.com/hc/en-us/articles/206430615-Events-and-Event-Properties#event-properties).
34
35
35
-
**Note**: Using custom events can impact your Iterable [billing](https://support.iterable.com/hc/articles/205480345#custom-event-usage-metrics). See [Monitoring Custom Event Usage](https://support.iterable.com/hc/en-us/articles/360043366492-Monitoring-Custom-Event-Usage) to learn how.
36
+
**Note**: Using custom events can impact your Iterable [billing](https://support.iterable.com/hc/articles/205480345#custom-event-usage-metrics).
36
37
37
38
### Prerequisites
38
39
39
-
Complete the following setup steps before you set up a Journey Campaign in Iterable.
40
-
41
40
In Segment, ensure you have:
42
41
43
42
* Set up your [Linked Audience](https://segment.com/docs/engage/audiences/linked-audiences/).
44
-
* A copy of your Linked Audience [Event Personalization Payload](https://segment.com/docs/engage/audiences/linked-audiences/#showhide-preview), event name, and Iterable user id.
43
+
* A copy of your Linked Audience event name and Iterable user id.
45
44
* Set up [Iterable as an actions destination](https://segment.com/docs/connections/destinations/catalog/actions-iterable/).
46
45
* Set up a [Custom Event destination action](https://segment.com/docs/connections/destinations/catalog/actions-iterable/#custom-event) and the relevant trigger using the [Linked Audiences](https://segment.com/docs/engage/audiences/linked-audiences/) workflow.
47
46
48
47
In Iterable, ensure you have:
49
48
50
49
* Permissions to access the application, or access to someone who has permissions.
51
50
* Created all Segment profiles as Iterables profiles using the [Upsert User destination action](https://segment.com/docs/connections/destinations/catalog/actions-iterable/#upsert-user) via [Connections](https://segment.com/docs/connections/) or [Reverse ETL](https://segment.com/docs/connections/reverse-etl/). This is a requirement for them to receive a campaign triggered by a custom event.
52
-
*Checked if your Segment Linked Audiences event was sent by [viewing the user's profile](https://support.iterable.com/hc/en-us/articles/218365803-Managing-User-Profiles#event-history) and [event history](https://support.iterable.com/hc/en-us/articles/218365803-Managing-User-Profiles#event-history). Review the****custom event payload schema so you know what properties to include in your message personalization.
51
+
*Review the custom event payload schema from your [Segment Linked Audiences test event](https://segment.com/docs/engage/audiences/linked-audiences/#step-3-send-a-test-event-to-your-destination) so you know what properties to include in your message personalization. You can do this by [accessing the user's profile](https://support.iterable.com/hc/en-us/articles/218365803-Managing-User-Profiles#event-history) and clicking into their [event history](https://support.iterable.com/hc/en-us/articles/218365803-Managing-User-Profiles#event-history)to see the specific properties.
53
52
* Created an Iterable profile, for campaign testing, with an email address you can access.
54
53
* Familiarity with the [Handlebars templating syntax](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars) to manually type out the code using dot notation.
55
54
@@ -63,21 +62,19 @@ In Iterable, do the following:
63
62
2. Add an [Email Message tile](https://support.iterable.com/hc/en-us/articles/12649121962260-Journey-Setup-Message-Tiles#setting-up-message-tiles), [create your campaign](https://support.iterable.com/hc/en-us/articles/14825389793556-Creating-a-Campaign), and connect it to your Start Tile.
64
63
3. Edit the content in your email:
65
64
1. Under Design, choose either the [WYSIWYG Editor](https://support.iterable.com/hc/en-us/articles/11554987128340-WYSIWYG-Editor) or the [Side by Side Editor](https://support.iterable.com/hc/en-us/articles/11555192523412-Side-by-Side-Editor).
66
-
2. Reference your Segment [custom event payload schema](https://support.iterable.com/hc/en-us/articles/360035402451-Event-Tracking-Testing-and-Troubleshooting) in Iterable to determine what properties to include in your message.
67
-
3. Translate the event properties in the payload schema into [Handlebars syntax](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars) for [custom events](https://support.iterable.com/hc/en-us/articles/206430615-Custom-Event-Properties#using-event-properties-to-customize-a-template), and enter it in the HTML editor in Iterable. See the personalization [examples below](# ???) for more specific details.
68
-
4. Choose any additional settings that apply and review and publish your journey. Then continue on to [Test your campaign flow](????) in Segment.
69
-
65
+
2. Reference your Segment custom event payload schema in Iterable to determine what properties to include in your message. You can do this by [accessing the user's profile](https://support.iterable.com/hc/en-us/articles/218365803-Managing-User-Profiles#event-history) and clicking into their [event history](https://support.iterable.com/hc/en-us/articles/218365803-Managing-User-Profiles#event-history) (Events > History > Details).
66
+
3. Translate the event properties in the payload schema into [Handlebars syntax](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars) for [custom events](https://support.iterable.com/hc/en-us/articles/206430615-Custom-Event-Properties#using-event-properties-to-customize-a-template), and enter it in the HTML editor in Iterable. See the personalization [examples below](#????) for more specific details.
67
+
4. Choose any additional settings that apply and review and [publish your journey](https://support.iterable.com/hc/en-us/articles/6027159030804-Building-Journeys#publishing-a-journey). Then continue on to Test your campaign flow in Segment.
70
68
71
69
## Step 2: Test your campaign flow
72
70
73
-
Open the Segment app and send yourself a test email for review. Add your Iterable user id and click **[Send test event to destination](https://segment.com/docs/engage/audiences/linked-audiences/#step-3-send-a-test-event-to-your-destination)**.
71
+
1.Open the Segment app and send yourself a test email for review. Add your Iterable user id and click ****[Send test event to destination](https://segment.com/docs/engage/audiences/linked-audiences/#step-3-send-a-test-event-to-your-destination)****. Review the email you received, and ensure it is formatted properly.
74
72
75
73

76
74
77
-
1. When the event is sent successfully to Iterable, you will see a `“message”: “success”` response in Segment.
78
-
79
-
2. Review the email you received, and ensure it is formatted properly. Open Iterable and check the [Campaign tab in Messaging Insights](https://support.iterable.com/hc/en-us/articles/360052814452-Messaging-Insights#viewing-metrics) (Insights > Messaging Insights > Campaigns > _[Your Unique Campaign])_ to confirm that Iterable has sent the message.
80
-
3. If your email doesn’t look the way you want it to, adjust the [Handlebars syntax](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars#referencing-user-profile-and-event-fields-with-handlebars) in Iterable, and send another test event. See the following [personalization examples](#???) for more specific details.
75
+
If the event is sent successfully to Iterable, you will see a `“message”: “success”` response in Segment.
76
+
2. Open Iterable and check the [Campaign tab in Messaging Insights](https://support.iterable.com/hc/en-us/articles/360052814452-Messaging-Insights#viewing-metrics) (Insights > Messaging Insights > Campaigns > _[Your Unique Campaign])_ to confirm that Iterable has sent the message.
77
+
3. If your email doesn’t look the way you want it to, adjust the [Handlebars syntax](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars#referencing-user-profile-and-event-fields-with-handlebars) in Iterable, and send another test event. See the following [personalization examples](#heading=h.9vszkxr0qiyi) for more specific details.
81
78
4. When you’re finished testing your campaign, proceed to [Enable your Linked Audience](https://github.com/segmentio/segment-docs/pull/6648/files#r1629472328).
82
79
83
80
# Handlebars Examples to use in Iterable
@@ -86,20 +83,46 @@ Use the following examples as context and information to experiment with setting
86
83
87
84
The following is an example of what your payload data might look like with nested payload properties:
88
85
86
+
```js
87
+
{
88
+
"event":"abandoned_carts_linked_audience",
89
+
"properties": {
90
+
"first_name":"Andrew",
91
+
"last_name":"Shopper",
92
+
"shopping_cart__id":"123",
93
+
"shopping_cart__products": [
94
+
{
95
+
"id":"324",
96
+
"product_name":"Premium Tennis Shoes",
97
+
"product_price":"$140",
98
+
"__entity":"product"
99
+
},
100
+
{
101
+
"id":"489",
102
+
"product_name":"Premium Jacket",
103
+
"product_price":"$200",
104
+
"__entity":"product"
105
+
}
106
+
],
107
+
"__entity":"cart"
108
+
}
109
+
}
110
+
```
111
+
89
112
The following helps translate you payload data into Handlebars syntax:
90
113
91
114
* To reference a specific event property:
92
115
* Use the following Handelbars syntax: <code>{% raw %}{{event_property_name}}{% endraw %}</code>
93
-
* An example of this property might look like: <code>{% raw %}{{first_name}}{% endraw %}</code>
116
+
* An example of this property might look like: <code>{% raw %}{{first_name}}{% endraw %}</code>
94
117
* To reference nested event properties within an Array:
95
-
* Use the following Handlebars syntax: <code>{% raw %}{{event_property_name.[#_that_represents_specific_entry_in_array].nested_event_property_name }{% endraw %}</code>
96
-
* An example of this property might look like: <code>{% raw %}{{shopping_cart__products[0].product_name}}{% endraw %}</code>
118
+
* Use the following Handlebars syntax: <code>{% raw %}{{event_property_name.[#_that_represents_specific_entry_in_array].nested_event_property_name }{% endraw %}</code>
119
+
* An example of this property might look like: <code>{% raw %}{{shopping_cart__products[0].product_name}}{% endraw %}</code>
97
120
98
121
You can read more on how to reference [event properties](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars#referencing-user-profile-and-event-fields-with-handlebars) and [nested properties](https://support.iterable.com/hc/en-us/articles/360031118392-Handlebars-FAQ#how-do-i-reference-items-in-a-nested-object) in Handlebars.
99
122
100
123
### Basic Email Example
101
124
102
-
Use the Segment custom event payload schema to build an abandoned cart email campaign that includes specific information for the product in a customer’s shopping cart.
125
+
Use the Segment custom event payload schema to build an abandoned cart email campaign that includes specific information for the product in a customer’s shopping cart.
103
126
104
127
When an email is sent, it lists the specific product and its related price in your customer’s shopping cart. It might look like the following screenshot:
105
128
@@ -130,10 +153,9 @@ Quick, now is your chance to own this item before it sells out!
130
153
```
131
154
{% endraw %}
132
155
133
-
134
156
### Advanced Email Example
135
157
136
-
Use the Segment custom event payload schema to build an abandoned cart email campaign where you can [#each](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars#iterating-over-all-values-each) to run a block of code repeatedly. In this example, you can use a for loop to list all of the products and their related prices in a customer’s shopping cart.
158
+
UUse the Segment custom event payload schema to build an abandoned cart email campaign where you can use[#each](https://support.iterable.com/hc/en-us/articles/205480365-Personalizing-Templates-with-Handlebars#iterating-over-all-values-each) to run a block of code repeatedly. In this example, you can use a for loop to list all of the products and their related prices in a customer’s shopping cart.
137
159
138
160
When an email is sent, it lists all of the products and their related prices in your customer’s shopping cart. It might look like the following screenshot:
139
161
@@ -164,6 +186,7 @@ We noticed you added some items to your shopping cart. Here's what you left: <br
164
186
{{/each}}
165
187
166
188
Quick, now is your chance to own these items before they sell out!
0 commit comments