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/event-mapping-configuration.md
+35-47
Original file line number
Diff line number
Diff line change
@@ -3,36 +3,26 @@ title: Engage Event Mapping
3
3
plan: engage-foundations
4
4
---
5
5
6
-
This guide explains how to configure mappings for Engage events in Actions Destinations,
6
+
This guide explains how to configure mappings for Engage events in [Actions Destinations](/docs/connections/destinations/actions/).
7
7
8
8
## Overview
9
9
10
-
Engage Mappings let you transform and send user data to downstream destinations. Engage events sent to destinations may need to be formatted or adjusted, though, to match the destination’s expected data structure. Without mapping, critical user information like audience membership or enriched traits may not sync correctly.
10
+
Engage mappings let you transform and send user data to downstream destinations. Engage events sent to destinations may need to be formatted or adjusted, though, to match the destination’s expected data structure. Without mapping, critical user information like audience membership or enriched traits may not sync correctly.
11
11
12
12
This guide covers:
13
13
14
14
- The differences between [Identify](/docs/connections/spec/identify/) and [Track](/docs/connections/spec/track/) events.
15
15
- How to extract and map data from Engage event payloads.
16
16
- A step-by-step walkthrough of mapping configurations.
17
-
- Advanced features like Trait Enrichment that you can use to pass additional profile data.
17
+
- Advanced features like trait enrichment that you can use to pass additional profile data.
18
18
19
19
## About Engage events
20
20
21
21
Before you create a mapping, you need to understand how Segment structures Engage events. Where the data lives in each event affects how you map it.
22
22
23
-
Engage sends two types of events: Identify and Track. These two event types use different parts of the event payload to store user data. If you're mapping an email address, an audience membership, or a trait like `first_name`, you need to know where to look for that value in each event type.
23
+
This section lists the important Engage event fields, breaks down the difference between Identify and Track events, shows you what each payload looks like, and explains where to find data you'll typically want to map so you can configure mappings correctly and avoid pitfalls.
24
24
25
-
If you map from the wrong part of the payload, your data might not reach the destination at all, or it might show up incorrectly.
26
-
27
-
This section breaks down the difference between Identify and Track events, shows you what each payload looks like, and explains where to find data you'll typically want to map so you can configure mappings correctly and avoid pitfalls.
- User identifiers (like `userId` and `anonymousId`)
32
-
- Audience membership status
33
-
- Other user traits, if you've enabled enrichment
34
-
35
-
## Key Engage event fields
25
+
### Key Engage event fields
36
26
37
27
The following properties appear in Engage event payloads:
38
28
@@ -44,7 +34,7 @@ The following properties appear in Engage event payloads:
44
34
|`context.traits`| Object | In Track events, this object stores user attributes like `email`. |
45
35
|`properties`| Object | Stores event-related data, including audience membership. |
46
36
47
-
Understanding these fields will help you correctly set up mappings and send Engage data to external destinations. -->
37
+
Understanding these fields will help you correctly set up mappings and send Engage data to external destinations.
48
38
49
39
### Engage event types and structure
50
40
@@ -55,6 +45,27 @@ Engage uses two event types to deliver data to downstream destinations:
55
45
56
46
These events structure data differently, which directly affects how you should configure mappings.
57
47
48
+
### Understanding the difference between Identify and Track in Engage
49
+
50
+
Engage sends both Identify and Track events when a user enters or exits an audience. While these events can contain similar information, they serve different purposes.
51
+
52
+
Identify events answer the question, "Who is this user right now?" They update the user’s profile with traits like email, name, and audience membership. For example: “Jane’s email is `[email protected]`. She’s in the `browse_abandoners` audience. Her first name is `jane`.”
53
+
54
+
Track events capture a specific moment in time, like when a user joins or leaves an audience. For example: “Jane just entered the `browse_abandoners` audience.”
55
+
56
+
Engage sends both types of events because different destinations rely on different types of data. Identify events are used to keep user profiles up to date, whereas Track events are useful for triggering time-sensitive actions based on audience entry or exit.
57
+
58
+
For example, you might use an Identify event to sync the current list of users in an audience to your CRM. But if you want an ad platform to show an ad the moment someone enters an audience, you'd use a Track event.
59
+
60
+
The following table summarizes the differences between Identify and Track events in Engage:
Identify events represent who the user is. These events usually update or enrich profiles in destinations like CRMs and email tools.
@@ -83,7 +94,7 @@ Here's an example of an Engage Identify event payload:
83
94
84
95
In this example, a user just entered the `browse_abandoners` audience. If the value for the audience were `false`, it would mean the user just **exited** the audience.
85
96
86
-
### Track events: logging user actions
97
+
####Track events: logging user actions
87
98
88
99
Track events, on the other hand, represent something the user did. These events capture user actions and log events and behaviors.
89
100
@@ -117,28 +128,7 @@ Here's an example of an Engage Track event payload:
117
128
118
129
In this example, a user just entered the `browse_abandoners` audience. The audience flag and traits are nested in `properties`, and the email address is in `context.traits.email`.
119
130
120
-
### Understanding the difference between Identify and Track in Engage
121
-
122
-
Engage sends both Identify and Track events when a user enters or exits an audience. While these events can contain similar information, these events serve different purposes.
123
-
124
-
Identify events answer the question, "Who is this user right now?" They update the user’s profile with traits like email, name, and audience membership. For example: “Jane’s email is `[email protected]`. She’s in the `browse_abandoners` audience. Her first name is `jane`.”
125
-
126
-
Track events capture a specific moment in time, like when a user joins or leaves an audience. For example: “Jane just entered the `browse_abandoners` audience.”
127
-
128
-
Engage sends both types of events because different destinations rely on different types of data. Identify events are used to keep user profiles up to date, whereas Track events are useful for triggering time-sensitive actions based on audience entry or exit.
129
-
130
-
For example, you might use an Identify event to sync the current list of users in an audience to your CRM. But if you want an ad platform to show an ad the moment someone enters an audience, you'd use a Track event.
131
-
132
-
The following table summarizes the differences between Identify and Track events in Engage:
Now that you understand the different purposes each event type serves, you're ready to configure a mapping.
142
132
143
133
## Configure mappings
144
134
@@ -150,8 +140,8 @@ The following sections walk through each event type and show how to configure a
150
140
151
141
Before you begin, make sure you've done the following:
152
142
153
-
- Created an audience in Engage
154
-
- Connected an Actions destination
143
+
- Created [an audience in Engage](/docs/engage/audiences/)
144
+
- Connected an [Actions destination](/docs/connections/destinations/actions/#available-actions-based-destinations)
155
145
- Confirmed whether the destination expects Identify or Track events
156
146
- Located your audience key (you'll use it to configure the trigger)
157
147
@@ -160,7 +150,7 @@ Before you begin, make sure you've done the following:
160
150
To create a mapping, follow these steps:
161
151
162
152
1. In your Segment workspace, go to **Connections > Destinations**.
163
-
2. Select the destination where you want to send Engage data.
153
+
2. Select the (Actions) destination you want to send Engage data to.
164
154
3. On the destination overview page, click **Mappings > + New mapping**.
165
155
4. Choose the event type you want to use: Identify or Track.
166
156
@@ -170,8 +160,6 @@ After you select the event type, you'll configure a trigger to determine when th
170
160
171
161
Before mapping fields, you’ll define a trigger that determines when the mapping executes. For Engage events, triggers typically use the audience key's boolean value.
172
162
173
-
So to trigger the mapping when a user enters or exits an audience, you'd use the audience key and its boolean value:
174
-
175
163
When a user enters the audience, configure the trigger like this:
176
164
177
165
- Trigger type: `Event Trait`
@@ -190,7 +178,7 @@ This tells Segment to execute the mapping only when the value of the audience ke
190
178
191
179
The fields you map depend on whether you selected Identify or Track.
192
180
193
-
#### Map an Identify event
181
+
#### 3a. Map an Identify event
194
182
195
183
Since Identify events send data in the `traits` object, you'll use `traits` in your mappings, like in this example:
196
184
@@ -220,7 +208,7 @@ Here’s how you might configure your mapping for this Identify event:
220
208
221
209
<!-- Maybe add screenshot-->
222
210
223
-
#### Map a Track event
211
+
#### 3b. Map a Track event
224
212
225
213
Track events send data in the `properties` object, like in this example:
226
214
@@ -264,7 +252,7 @@ Once you've decided whether to map a Track or Identify event, finish by followin
264
252
265
253
## Trait enrichment
266
254
267
-
Trait Enrichment lets you pull Segment profile traits into mappings when syncing audiences or journeys to destinations and [Destination functions](/docs/connections/functions/destination-functions/).
255
+
Trait enrichment lets you pull Segment profile traits into mappings when syncing audiences or journeys to destinations and [Destination functions](/docs/connections/functions/destination-functions/).
0 commit comments