Campaign event example: Braze
Campaign event: email send
Starting with an example of email send event type (users.messages.email.Send
) records that are provided from Braze, we will use those to map to the Campaign Event feed layout. This will be the primary event that all of the other email event types will link to.
There are a few different things you need to consider when mapping source data:
Required fields
Campaign, creative, and segmentation information
Personally identifiable information (PII)
Sample send events
Below are a couple of examples of send events from Braze.
Send Event Example 1:
{
"events": [
{
"event_type": "users.messages.email.Send",
"id": "96a9bfb8-e889-4748-ba27-db165be911a1",
"time": 1697831846,
"user": {
"user_id": "6532cf534764af00014d1c66",
"external_user_id": "11034"
},
"properties": {
"campaign_id": "785b9efb-19c2-4868-b6bf-a09b6262fb57",
"message_variation_id": "dac0d9d9-3d54-480a-b8d1-03179f85e9a2",
"dispatch_id": "6532db9ed37634647bf3902b7fbbb1b5",
"campaign_name": "RPI_Campaign_04",
"message_variation_name": "Variant 1",
"email_address": "braze-026c3e+1000@inbox.mailtrap.io",
"ip_pool": null,
"message_extras": "{\"chid\":\"82348235\"}"
}
}
]
}
Send Event Example 2:
{
"events": [
{
"event_type": "users.messages.email.Send",
"id": "a53ec45f-7e9e-41ec-9dcd-ffbfb264c610",
"time": 1697831849,
"user": {
"user_id": "6532cf534764af00014d1c8e",
"external_user_id": "11035"
},
"properties": {
"campaign_id": "785b9efb-19c2-4868-b6bf-a09b6262fb57",
"message_variation_id": "dac0d9d9-3d54-480a-b8d1-03179f85e9a2",
"dispatch_id": "6532db9ed37634647bf3902b7fbbb1b5",
"campaign_name": "RPI_Campaign_04",
"message_variation_name": "Variant 1",
"email_address": "braze-026c3e+1001@inbox.mailtrap.io",
"ip_pool": null,
"message_extras": "{\"chid\":\"82348235\"}"
}
}
]
}
Mapping send events to campaign event NonRPI feed layout
Below is a streamlined version of the Campaign Event NonRPI feed layout details (with a reduced number of columns found in the data ingestion details section of the documentation). We will use this table and the sample send events above to outline the mapping of the events to the feed layout. There are two additional columns: one for the Braze source field or static data value, and a second for notes related to the mapping.
The PII fields at the bottom of the feed layout that are in italics indicate the PII target fields that are not provided in the source event examples above.
Streamlined version of the campaign event feed layout:
Business name | Field name | Description | Field data type/length | Braze source | Notes |
---|---|---|---|---|---|
System of Record Name |
| (Required) Name of the system that is the authoritative data source for a record. |
| | Static value that should be hard coded when generating the feed layout. |
Client Campaign Event Id |
| (Required) Uniquely identifies marketing campaign event for this data source (defined in the API config). |
| id | |
Campaign Event Datetime |
| (Required) Run Date: The day and time your advertisement appears in the publication; also known as insertion date:
|
| Time | |
Business Unit Code |
| Business Unit identifies the structure of brands within an organizational entity. It is the way in which the brands within a company’s portfolio are related to, and differentiated from, one another. Values are defined as part of on-boarding, in |
| Not Available By Default | |
Creative Text |
| The content of the creative. |
| Not Available | |
Campaign Code |
| (Required) Uniquely identifies the marketing campaign; a specific series of strategies, tactics, and activities designed to get desired marketing or other messages to intended target markets. |
| | |
Campaign Name |
| Marketing campaign's name. |
| | |
Campaign Description |
| Marketing campaign's description. |
| Not Available By Default | |
Campaign Start Date |
| Date when marketing campaign starts: |
| Not Available By Default | |
Campaign End Date |
| Date when marketing campaign ends: |
| Not Available By Default | |
Cell Code |
| Uniquely identifies the cell, which is a 'definable' segment - a mass of people who can be identified and targeted with reasonable effort, cost, and time. |
|
| |
Cell Name |
| A name of the cell, which is a 'definable' segment - a mass of people who can be identified and targeted with reasonable effort, cost, and time. |
|
| |
Offer Code |
| Identifies a coupon, discount, etc. developed for use in marketing (direct or other types) that is available to be sent to the parties within one or more campaigns. |
| Not Available By Default | |
Offer Code Value |
| Coupon's value. |
| Not Available By Default | |
Drop Date |
| Marketing drop date: |
| Not Applicable | Not applicable, as this is used for Direct Mail. |
Control Group Indicator |
| When
|
|
| Control groups are not identified for extract in Braze, so leaving it blank or just setting all record to |
Channel Code |
| Uniquely identifies a communication channel such as direct mail, email, phone, social media, web, mobile, call center, display media, etc. Values are defined as part of on-boarding, in |
| | |
Audience Id |
| Audiences can be defined by either email address, Facebook UIDs, phone numbers, names, date of birth, gender, locations, app user IDs, Apple's Advertising Identifier (IDFA), Android's advertising ID or by a combination of rules used to identify users who took specific actions on your website. |
| | You could use one or all of these (concatenating them with underscores), although we expect that Example of the concatenated version:
|
Source Party Profile Id |
| Customer id - Uniquely identifies the customer's record in the client's system. |
|
| We will not populate this field unless we will be ingesting Party profile data from Braze. In that case, we would use whatever was determined to be the source party profile for Braze data in this field. An option would be |
Address 1 |
| Address Line 1. |
|
| |
Address 2 |
| Address Line 2. |
|
| |
Address 3 |
| Address Line 3. |
|
| |
Address 4 |
| Address Line 4. |
|
| |
City |
| City Name. |
|
| |
State Province |
| State Code. |
|
| |
Postal Code 1 |
| Postal Code. |
|
| |
Country Code |
| Country Code. |
|
| |
Home Phone Country Code |
| ISO standard 2 char code Country Code of home phone. |
|
| |
Home Phone Number |
| Customer's home phone number including area code. |
|
| |
Mobile Phone Country Code |
| ISO standard 2 char code Country Code of mobile phone. |
|
| |
Mobile Phone Number |
| Customer's cell phone number including area code. |
|
| |
Work Phone Country Code |
| ISO standard 2 char code Country Code of work phone. |
|
| |
Work Phone Number |
| Customer's work phone number including area code. |
|
| |
Other Phone Country Code |
| ISO standard 2 char code Country Code of other phone . |
|
| |
Other Phone Number |
| Customer's other phone number including area code. |
|
| |
Other Phone Type Code |
| The type of the phone such as billing, shipping, home, work, primary, mobile, other as defined in the reference data worksheet. Values are defined as part of on-boarding, in PHONE_TYPE. Refer to Phone type for details. |
|
| |
Email Address |
| Customer's email address. |
|
|