Response event example: Braze

The following pages show how to use the Response Event Feed Layout based on Braze response data.

When loading the response data you will need to link the responses to the original campaign event record (Send Event) to load the records. The way to link the email response data from Braze back to the Campaign Event is by joining to the Campaign Event Records on campaign_id (campaign_code) and email_address.

Currently, associating the response data to the specific campaign event record needs to be done outside of the CDP before the record is provided via the Response Event feed layout.

Sample Braze events

Below are a few of the different events you can get back from Braze. In the subsequent pages, we will review creating a response file for each of the events listed below.

Delivery

JSON

{
  "events": [
    {
      "event_type": "users.messages.email.Delivery",
      "id": "0542f19a-0a8a-4bf9-ab6a-184487aa633f",
      "time": 1700515500,
      "user": {
        "user_id": "6532cf534764af00014d1c8e",
        "external_user_id": "11035"
      },
      "properties": {
        "campaign_id": "f7428cc5-2fc6-424c-9a2c-61e91a30d0ac",
        "message_variation_id": "bf09dffe-43f5-481e-9bd9-576f026312d1",
        "dispatch_id": "655bcea34c4185eadd8ab7b07dbc5a9e",
        "campaign_name": "RP_CAMPAIGN_20231120_SEND01",
        "message_variation_name": "Variant 1",
        "email_address": "braze-026c3e+1001@inbox.mailtrap.io",
        "sending_ip": "137.22.228.115",
        "ip_pool": "partner_us03_ip_pool",
        "esp": "SparkPost",
        "from_domain": "e.partnerus03.us.abmarketing01.com"
      }
    }
  ]
}

Open event

JSON

{
  "events": [
    {
      "event_type": "users.messages.email.Open",
      "id": "5355d603-5e86-4ee1-8864-360361fe1f77",
      "time": 1700515596,
      "user": {
        "user_id": "6532cf544764af00014d1c96",
        "external_user_id": "11036"
      },
      "properties": {
        "campaign_id": "f7428cc5-2fc6-424c-9a2c-61e91a30d0ac",
        "message_variation_id": "6cda6825-879c-469c-87a0-50cdf6a31d6d",
        "dispatch_id": "655bcea34c4185eadd8ab7b07dbc5a9e",
        "campaign_name": "RP_CAMPAIGN_20231120_SEND01",
        "message_variation_name": "Variant 2",
        "email_address": "braze-026c3e+1002@inbox.mailtrap.io",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
        "ip_pool": "partner_us03_ip_pool",
        "esp": "SparkPost",
        "from_domain": "e.partnerus03.us.abmarketing01.com",
        "is_amp": null,
        "machine_open": null
      }
    }
  ]
}

Click event

JSON

{
  "events": [
    {
      "event_type": "users.messages.email.Click",
      "id": "08684697-8857-4d51-8a4a-daed11963fe0",
      "time": 1700515693,
      "user": {
        "user_id": "6532cf534764af00014d1c66",
        "external_user_id": "11034"
      },
      "properties": {
        "campaign_id": "f7428cc5-2fc6-424c-9a2c-61e91a30d0ac",
        "message_variation_id": "6cda6825-879c-469c-87a0-50cdf6a31d6d",
        "dispatch_id": "655bcea34c4185eadd8ab7b07dbc5a9e",
        "campaign_name": "RP_CAMPAIGN_20231120_SEND01",
        "message_variation_name": "Variant 2",
        "email_address": "braze-026c3e+1000@inbox.mailtrap.io",
        "url": "http://www.redpointglobal.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
        "ip_pool": "partner_us03_ip_pool",
        "esp": "SparkPost",
        "from_domain": "e.partnerus03.us.abmarketing01.com",
        "is_amp": null,
        "link_id": null,
        "link_alias": null
      }
    }
  ]
}

Bounce event

JSON

{
  "events": [
    {
      "event_type": "users.messages.email.SoftBounce",
      "id": "bb84506e-3425-475a-ab86-77540d9487b9",
      "time": 1700535251,
      "user": {
        "user_id": "655c14f6ee8376000173bbf1",
        "external_user_id": "123AAF"
      },
      "properties": {
        "campaign_id": "5394d36e-da52-4863-a7da-6a48944d7448",
        "message_variation_id": "b47c007c-a5e9-458f-8c63-18946c5c69fc",
        "dispatch_id": "655c1bcd0366f319f20c20c44f514e46",
        "campaign_name": "RP_CAMPAIGN_20231120_SEND03",
        "message_variation_name": "Variant 2",
        "email_address": "dan.santos@redpointbad.com",
        "sending_ip": "137.22.228.115",
        "ip_pool": "partner_us03_ip_pool",
        "esp": "SparkPost",
        "from_domain": "e.partnerus03.us.abmarketing01.com",
        "bounce_reason": "554 5.4.4 [internal] Domain Does Not Exist"
      }
    }
  ]
}

Mapping response events to response event 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.

Streamlined version of the response event feed layout:

Business name	Field name	Description	Field data type/length	Braze source	Notes
System of Record Name	`sor_name`	Name of the system that is the authoritative data source for a record.	`char(100)`	`BRAZE`
Rp Contact Id	`rp_contact_id`	Uniquely identifies marketing campaign event within RPI (Redpoint Interaction) that response event is related to. To support response attribution, this value is used to link a response event to promotion event.	`number`
Rp Event Id	`rp_event_id`	Uniquely identifies response event within RPI (Redpoint Interaction).	`number`
Client Campaign Event Id	`client_campaign_event_id`	(Required) Uniquely identifies marketing campaign event the response event is related to. To support response attribution, this value is used to link a response event to promotion event.	`char(150)`	`client_campaign_event_id`	This value comes from the campaign event record and needs to be associated to the response record before it can be loaded.
Client Response Event Id	`client_response_event_id`	(Required) Uniquely identifies a response event for the identity id listed below in the system of record.	`char(150)`	id
Response Event Datetime	`response_event_datetime`	(Required) Response Datetime: `YYYY-MM-DD HH:mm:ss`	`datetime`	time (needs to be converted from an epoch to a timestamp)	This time is in epoch format and needs to be converted and formatted to meet the date time format to pass validation.
Channel Code	`channel_code`	Uniquely identifies a communication channel used for response such as direct mail, Email, phone, social media, web, mobile, call center, display media, etc. Values are defined as part of on-boarding, in `CHANNEL_LOOKUP`. Refer to Channel for details.	`char(100)`	email
Event Disposition Code	`event_disposition_code`	(Required) Uniquely identifies a disposition code for phone (wrong number, not valid phone, etc.), for direct mail (mail returned, undeliverable as addressed, etc., or for email (hard bounce, soft bounce, opened, click through, delivered). Values are defined as part of on-boarding, in `EVENT_DISPOSITION_LOOKUP`. Refer to Event disposition for details.	`char(50)`	bounced clicked `undeliverable` opened `processed` `reported_as_spam` `unsubscribed` `sent` delivered `forward` `group_unsubscribes` `group_resubscribes` `dropped` `not_provided`	You need to convert the event type to the appropriate event disposition code. For example this event type, `"event_type": "users.messages.email.Click"` would be converted to `"clicked"`.
Destination Url Address	`destination_url_address`	A Destination URL is the address of the webpage people reach when they click on the ad.	`char(4000)`	url
Referral Url Address	`referral_url_address`	The address of the webpage where a person clicked a link that sent them to destination page. The referrer is the webpage that sends visitors to your site using a link.	`char(4000)`
Search Keyword Text	`search_keyword_text`	Search keyword captured.	`char(100)`
Source Record Create Datetime	`source_rec_create_datetime`	The datetime when the record was created at source system: `YYYY-MM-DD HH:mm:ss`	`datetime`
Source Record Update Datetime	`source_rec_update_datetime`	The datetime of the latest update of the record at source system: `YYYY-MM-DD HH:mm:ss`	`datetime`