Braze Integration Reference

Contents

Introduction

Whenever events are generated, Radar will send custom events and user attributes to Braze. The full list of supported user attributes and events is below.

User mapping

By default, Radar userId maps to Braze external_id for logged in users. However, you can track logged out users or specify custom mappings by setting Radar metadata.brazeAlias or metadata.brazeExternalId. If you set metadata.brazeAlias, you must also add a matching alias in Braze with label radarAlias. For example, on iOS:

// track logged out users with alias (deviceId recommended, not required if not tracking logged out users)
Radar.setMetadata(["brazeAlias": deviceId])
Appboy.sharedInstance()?.user.addAlias(deviceId, withLabel: "radarAlias")

// track logged in users with custom external_id mapping (not required if using default mapping)
Radar.setMetadata(["brazeExternalId": userId])
Appboy.sharedInstance()?.changeUser(userId)

Note that Radar uses the special string "(null)" to represent null user attribute values.

Radar User Field Braze User Attribute Type Example Value
metadata.brazeExternalId or userId external_id string "1"
metadata.br or userId external_id string "1"
location current_location location (39.525665, -76.350663)
_id radar_id string "5b2c0906f5874b001aecfd8d"
updatedAt radar_updated_at timestamp "2018-06-22T15:23:39.000Z"
geofences[]._id radar_geofence_ids array[string] ["5b2c0906f5874b001aecfd8e"]
geofences[].description radar_geofence_descriptions array[string] ["Bel Air"]
geofences[].tag radar_geofence_tags array[string] ["city"]
geofences[].externalId radar_geofence_external_ids array[string] ["bel-air"]
place._id radar_place_id string "59302bcf8f27e8a156bd4f91"
place.name radar_place_name string "Target Bel Air"
place.facebookId radar_place_facebook_id string "141162456060553"
place.categories radar_place_categories array[string] ["shopping-retail"]
place.chain.slug radar_place_chain_slug string "target"
place.chain.name radar_place_chain_name string "Target"
insights.state.home radar_insights_state_home boolean false
insights.state.office radar_insights_state_office boolean false
insights.state.traveling radar_insights_state_traveling boolean true

Event mapping

Radar Event Braze Event
user.entered_geofence entered_geofence
user.exited_geofence exited_geofence
user.entered_place entered_place
user.exited_place exited_place
user.entered_home entered_home
user.exited_home exited_home
user.entered_office entered_office
user.exited_office exited_office
user.started_traveling started_traveling
user.stopped_traveling stopped_traveling

entered_geofence

Radar Event Field Braze Event Property Type Example Value
geofence._id geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description geofence_description string "Bel Air"
geofence.tag geofence_tag string "city"
geofence.externalId geofence_external_id string "bel-air"
confidence confidence string "high"

exited_geofence

Radar Event Field Braze Event Property Type Example Value
geofence._id geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description geofence_description string "Bel Air"
geofence.tag geofence_tag string "city"
geofence.externalId geofence_external_id string "bel-air"
confidence confidence string "high"
duration duration number (minutes) 42.1

entered_place

Radar Event Field Braze Event Property Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Target Bel Air"
place.facebookId place_facebook_id string "141162456060553"
place.chain.slug place_chain_id string "target"
place.chain.name place_chain_name string "Target"
place.categories place_categories string (comma-separated) "shopping-retail"
confidence confidence string "high"

exited_place

Radar Event Field Braze Event Property Type Example Value
place._id place_id string "59302bcf8f27e8a156bd4f91"
place.name place_name string "Target Bel Air"
place.facebookId place_facebook_id string "141162456060553"
place.chain.slug place_chain_id string "target"
place.chain.name place_chain_name string "Target"
place.categories place_categories string (comma-separated) "shopping-retail"
confidence confidence string "high"
duration duration number (minutes) 42.1

entered_home

Radar Event Field Braze Event Property Type Example Value
confidence confidence string "high"

exited_home

Radar Event Field Braze Event Property Type Example Value
confidence confidence string "high"

entered_office

Radar Event Field Braze Event Property Type Example Value
confidence confidence string "high"

exited_office

Radar Event Field Braze Event Property Type Example Value
confidence confidence string "high"

started_traveling

Radar Event Field Braze Event Property Type Example Value
confidence confidence string "high"

stopped_traveling

Radar Event Field Braze Event Property Type Example Value
confidence confidence string "high"