Skip to content

Commit 78774ff

Browse files
committed
some more rearranging [netlify-build]
1 parent 99c882d commit 78774ff

File tree

1 file changed

+35
-47
lines changed

1 file changed

+35
-47
lines changed

src/engage/event-mapping-configuration.md

+35-47
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,26 @@ title: Engage Event Mapping
33
plan: engage-foundations
44
---
55

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/).
77

88
## Overview
99

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.
1111

1212
This guide covers:
1313

1414
- The differences between [Identify](/docs/connections/spec/identify/) and [Track](/docs/connections/spec/track/) events.
1515
- How to extract and map data from Engage event payloads.
1616
- 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.
1818

1919
## About Engage events
2020

2121
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.
2222

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.
2424

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.
28-
29-
<!-- Engage events carry critical information, including:
30-
31-
- 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
3626

3727
The following properties appear in Engage event payloads:
3828

@@ -44,7 +34,7 @@ The following properties appear in Engage event payloads:
4434
| `context.traits` | Object | In Track events, this object stores user attributes like `email`. |
4535
| `properties` | Object | Stores event-related data, including audience membership. |
4636

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.
4838

4939
### Engage event types and structure
5040

@@ -55,6 +45,27 @@ Engage uses two event types to deliver data to downstream destinations:
5545

5646
These events structure data differently, which directly affects how you should configure mappings.
5747

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:
61+
62+
| Attribute | Identify | Track |
63+
| ---------------------- | ----------------------------------------- | ----------------------------------------------------- |
64+
| What it describes | The user’s current traits and attributes | A specific moment or action (like audience entry) |
65+
| When to use it | To update a user profile in a destination | To trigger an action based on something that happened |
66+
| Audience data location | `traits` | `properties` |
67+
| Email location | `traits.email` | `context.traits.email` |
68+
5869
#### Identify events: updating user traits
5970

6071
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:
8394

8495
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.
8596

86-
### Track events: logging user actions
97+
#### Track events: logging user actions
8798

8899
Track events, on the other hand, represent something the user did. These events capture user actions and log events and behaviors.
89100

@@ -117,28 +128,7 @@ Here's an example of an Engage Track event payload:
117128

118129
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`.
119130

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:
133-
134-
| Attribute | Identify | Track |
135-
| ---------------------- | ----------------------------------------- | ----------------------------------------------------- |
136-
| What it describes | The user’s current traits and attributes | A specific moment or action (like audience entry) |
137-
| When to use it | To update a user profile in a destination | To trigger an action based on something that happened |
138-
| Audience data location | `traits` | `properties` |
139-
| Email location | `traits.email` | `context.traits.email` |
140-
141-
<!-- PW: maybe add a transition here -->
131+
Now that you understand the different purposes each event type serves, you're ready to configure a mapping.
142132

143133
## Configure mappings
144134

@@ -150,8 +140,8 @@ The following sections walk through each event type and show how to configure a
150140

151141
Before you begin, make sure you've done the following:
152142

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)
155145
- Confirmed whether the destination expects Identify or Track events
156146
- Located your audience key (you'll use it to configure the trigger)
157147

@@ -160,7 +150,7 @@ Before you begin, make sure you've done the following:
160150
To create a mapping, follow these steps:
161151

162152
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.
164154
3. On the destination overview page, click **Mappings > + New mapping**.
165155
4. Choose the event type you want to use: Identify or Track.
166156

@@ -170,8 +160,6 @@ After you select the event type, you'll configure a trigger to determine when th
170160

171161
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.
172162

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-
175163
When a user enters the audience, configure the trigger like this:
176164

177165
- Trigger type: `Event Trait`
@@ -190,7 +178,7 @@ This tells Segment to execute the mapping only when the value of the audience ke
190178

191179
The fields you map depend on whether you selected Identify or Track.
192180

193-
#### Map an Identify event
181+
#### 3a. Map an Identify event
194182

195183
Since Identify events send data in the `traits` object, you'll use `traits` in your mappings, like in this example:
196184

@@ -220,7 +208,7 @@ Here’s how you might configure your mapping for this Identify event:
220208

221209
<!-- Maybe add screenshot-->
222210

223-
#### Map a Track event
211+
#### 3b. Map a Track event
224212

225213
Track events send data in the `properties` object, like in this example:
226214

@@ -264,7 +252,7 @@ Once you've decided whether to map a Track or Identify event, finish by followin
264252

265253
## Trait enrichment
266254

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/).
268256

269257
To enable trait enrichment:
270258

0 commit comments

Comments
 (0)