Braze

Whenever events are generated, Radar will send custom events and user attributes to Braze. The full list of supported events and 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	Context Type
`metadata.brazeExternalId` or `userId`	`external_id`	string	`"1"`
`metadata.brazeAlias`	`radarAlias`	string	`"10974a2ee035770b9"`
`location`	`current_location`	location	`(39.525665, -76.350663)`
`_id`	`radar_id`	string	`"5b2c0906f5874b001aecfd8d"`
`updatedAt`	`radar_updated_at`	timestamp	`"2018-06-22T15:23:39.000Z"`
`segments[*].externalId`	`radar_segment_external_ids`	array[string]	`["starbucks-visitors"]`
`topChains[*].slug`	`radar_top_chain_slugs`	array[string]	`["starbucks", "walmart"]`
`topChains[*].externalId`	`radar_top_chain_external_ids`	array[string]	`["123", "456"]`
`geofences[*]._id`	`radar_geofence_ids`	array[string]	`["5b2c0906f5874b001aecfd8e"]`	Geofences
`geofences[*].description`	`radar_geofence_descriptions`	array[string]	`["Store #123"]`	Geofences
`geofences[*].tag`	`radar_geofence_tags`	array[string]	`["store"]`	Geofences
`geofences[*].externalId`	`radar_geofence_external_ids`	array[string]	`["123"]`	Geofences
`place._id`	`radar_place_id`	string	`"59302bcf8f27e8a156bd4f91"`	Places
`place.name`	`radar_place_name`	string	`"Starbucks"`	Places
`place.categories`	`radar_place_categories`	array[string]	`["food-beverage", "cafe", "coffee-shop"]`	Places
`place.chain.slug`	`radar_place_chain_id`	string	`"starbucks"`	Places
`place.chain.name`	`radar_place_chain_name`	string	`"Starbucks"`	Places
`insights.state.home`	`radar_insights_state_home`	boolean	`false`	Insights
`insights.state.office`	`radar_insights_state_office`	boolean	`false`	Insights
`insights.state.traveling`	`radar_insights_state_traveling`	boolean	`true`	Insights
`country.code`	`radar_region_country_code`	string	`"US"`	Regions
`country.name`	`radar_region_country_name`	string	`"United States"`	Regions
`state.code`	`radar_region_state_code`	string	`"MD"`	Regions
`state.name`	`radar_region_state_name`	string	`"Maryland"`	Regions
`dma.code`	`radar_region_dma_code`	string	`"26"`	Regions
`dma.name`	`radar_region_dma_name`	string	`"Baltimore"`	Regions
`postalCode.code`	`radar_region_postal_code`	string	`"21014"`	Regions

Event mapping

Radar Event	Context Type	Braze Event
`user.entered_geofence`	Geofences	`entered_geofence`
`user.exited_geofence`	Geofences	`exited_geofence`
`user.entered_place`	Places	`entered_place`
`user.exited_place`	Places	`exited_place`
`user.entered_home`	Insights	`entered_home`
`user.exited_home`	Insights	`exited_home`
`user.entered_office`	Insights	`entered_office`
`user.exited_office`	Insights	`exited_office`
`user.started_traveling`	Insights	`started_traveling`
`user.stopped_traveling`	Insights	`stopped_traveling`
`user.entered_region_country`	Regions	`entered_country`
`user.exited_region_country`	Regions	`exited_country`
`user.entered_region_state`	Regions	`entered_state`
`user.exited_region_state`	Regions	`exited_state`
`user.entered_region_dma`	Regions	`entered_dma`
`user.exited_region_dma`	Regions	`exited_dma`

entered_geofence

Radar Event Field	Braze Event Property	Type	Example Value
`geofence._id`	`geofence_id`	string	`"5b2c0906f5874b001aecfd8e"`
`geofence.description`	`geofence_description`	string	`"Store #123"`
`geofence.tag`	`geofence_tag`	string	`"store"`
`geofence.externalId`	`geofence_external_id`	string	`"123"`
`geofence.metadata[{key}]`	`geofence_metadata_{key}`	{type}	`{value}`
`confidence`	`confidence`	string	`"high"`

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field	Braze Event Property	Type	Example Value
`country.code`	`country_code`	string	`"US"`
`country.name`	`country_name`	string	`"United States"`
`state.code`	`state_code`	string	`"MD"`
`state.name`	`state_name`	string	`"Maryland"`
`dma.code`	`dma_code`	string	`"26"`
`dma.name`	`dma_name`	string	`"Baltimore"`
`postalCode.code`	`postal_code`	string	`"21014"`

exited_geofence

Radar Event Field	Braze Event Property	Type	Example Value
`geofence._id`	`geofence_id`	string	`"5b2c0906f5874b001aecfd8e"`
`geofence.description`	`geofence_description`	string	`"Store #123"`
`geofence.tag`	`geofence_tag`	string	`"store"`
`geofence.externalId`	`geofence_external_id`	string	`"123"`
`geofence.metadata[{key}]`	`geofence_metadata_{key}`	{type}	`{value}`
`confidence`	`confidence`	string	`"high"`
`duration`	`duration`	number (minutes)	`42.1`

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field	Braze Event Property	Type	Example Value
`country.code`	`country_code`	string	`"US"`
`country.name`	`country_name`	string	`"United States"`
`state.code`	`state_code`	string	`"MD"`
`state.name`	`state_name`	string	`"Maryland"`
`dma.code`	`dma_code`	string	`"26"`
`dma.name`	`dma_name`	string	`"Baltimore"`
`postalCode.code`	`postal_code`	string	`"21014"`

entered_place

Radar Event Field	Braze Event Property	Type	Example Value
`place._id`	`place_id`	string	`"59302bcf8f27e8a156bd4f91"`
`place.name`	`place_name`	string	`"Starbucks"`
`place.chain.slug`	`place_chain_id`	string	`"starbucks"`
`place.chain.name`	`place_chain_name`	string	`"Starbucks"`
`place.chain.externalId`	`place_chain_external_id`	string	`"123"`
`place.chain.metadata[{key}]`	`place_chain_metadata_{key}`	{type}	`{value}`
`place.categories`	`place_categories`	string (comma-separated)	`"food-beverage,cafe,coffee-shop"`
`confidence`	`confidence`	string	`"high"`

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field	Braze Event Property	Type	Example Value
`country.code`	`country_code`	string	`"US"`
`country.name`	`country_name`	string	`"United States"`
`state.code`	`state_code`	string	`"MD"`
`state.name`	`state_name`	string	`"Maryland"`
`dma.code`	`dma_code`	string	`"26"`
`dma.name`	`dma_name`	string	`"Baltimore"`
`postalCode.code`	`postal_code`	string	`"21014"`

exited_place

Radar Event Field	Braze Event Property	Type	Example Value
`place._id`	`place_id`	string	`"59302bcf8f27e8a156bd4f91"`
`place.name`	`place_name`	string	`"Starbucks"`
`place.chain.slug`	`place_chain_id`	string	`"starbucks"`
`place.chain.name`	`place_chain_name`	string	`"Starbucks"`
`place.chain.externalId`	`place_chain_external_id`	string	`"123"`
`place.chain.metadata[{key}]`	`place_chain_metadata_{key}`	{type}	`{value}`
`place.categories`	`place_categories`	string (comma-separated)	`"food-beverage,cafe,coffee-shop"`
`confidence`	`confidence`	string	`"high"`
`duration`	`duration`	number (minutes)	`42.1`

If Regions is enabled, Radar will also send the following attributes:

Radar Event Field	Braze Event Property	Type	Example Value
`country.code`	`country_code`	string	`"US"`
`country.name`	`country_name`	string	`"United States"`
`state.code`	`state_code`	string	`"MD"`
`state.name`	`state_name`	string	`"Maryland"`
`dma.code`	`dma_code`	string	`"26"`
`dma.name`	`dma_name`	string	`"Baltimore"`
`postalCode.code`	`postal_code`	string	`"21014"`

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"`

entered_country

Radar Event Attribute	Braze Event Property	Type	Example Value
`region.code`	`region_code`	string	`"US"`
`region.name`	`region_name`	string	`"United States"`
`confidence`	`confidence`	string	`"high"`

exited_country

Radar Event Attribute	Braze Event Property	Type	Example Value
`region.code`	`region_code`	string	`"US"`
`region.name`	`region_name`	string	`"United States"`
`confidence`	`confidence`	string	`"high"`

entered_state

Radar Event Attribute	Braze Event Property	Type	Example Value
`region.code`	`region_code`	string	`"MD"`
`region.name`	`region_name`	string	`"Maryland"`
`confidence`	`confidence`	string	`"high"`

exited_state

Radar Event Attribute	Braze Event Property	Type	Example Value
`region.code`	`region_code`	string	`"MD"`
`region.name`	`region_name`	string	`"Maryland"`
`confidence`	`confidence`	string	`"high"`

entered_dma

Radar Event Attribute	Braze Event Property	Type	Example Value
`region.code`	`region_code`	string	`"26"`
`region.name`	`region_name`	string	`"Baltimore"`
`confidence`	`confidence`	string	`"high"`

exited_dma

Radar Event Attribute	Braze Event Property	Type	Example Value
`region.code`	`region_code`	string	`"26"`
`region.name`	`region_name`	string	`"Baltimore"`
`confidence`	`confidence`	string	`"high"`

started_trip

Radar Event Attribute	Braze Event Property	Type	Example Value
`trip.externalId`	`trip_external_id`	string	`"299"`
`trip.metadata[{key}]`	`trip_metadata_{key}`	{type}	`{value}`
`trip.destinationGeofenceTag`	`trip_destination_geofence_tag`	string	`"store"`
`trip.destinationGeofenceExternalId`	`trip_destination_geofence_external_id`	string	`"123"`

approaching_trip_destination

Radar Event Attribute	Braze Event Property	Type	Example Value
`trip.externalId`	`trip_external_id`	string	`"299"`
`trip.metadata[{key}]`	`trip_metadata_{key}`	{type}	`{value}`
`trip.destinationGeofenceTag`	`trip_destination_geofence_tag`	string	`"store"`
`trip.destinationGeofenceExternalId`	`trip_destination_geofence_external_id`	string	`"123"`

arrived_at_trip_destination

Radar Event Attribute	Braze Event Property	Type	Example Value
`trip.externalId`	`trip_external_id`	string	`"299"`
`trip.metadata[{key}]`	`trip_metadata_{key}`	{type}	`{value}`
`trip.destinationGeofenceTag`	`trip_destination_geofence_tag`	string	`"store"`
`trip.destinationGeofenceExternalId`	`trip_destination_geofence_external_id`	string	`"123"`

stopped_trip

Radar Event Attribute	Braze Event Property	Type	Example Value
`trip.externalId`	`trip_external_id`	string	`"299"`
`trip.metadata[{key}]`	`trip_metadata_{key}`	{type}	`{value}`
`trip.destinationGeofenceTag`	`trip_destination_geofence_tag`	string	`"store"`
`trip.destinationGeofenceExternalId`	`trip_destination_geofence_external_id`	string	`"123"`