Braze

The Braze integration is available on the Enterprise plan.

Radar can send events and user attributes to Braze.

Use the Braze integration to send location-triggered and location-targeted messages to increase engagement and conversion.

Configuration#

On the Braze Developer Console page under Rest API Keys, create and copy a new app group API key with users.track permissions. Under Identification, copy your iOS and Android app identifiers.

Then, on the Radar Integrations page under Braze, set Enabled to Yes and paste your API key and app identifiers. Note that you can set separate API keys and app identifiers for the Test and Live environments. Finally, if your account is not on https://rest.iad-01.braze.com, select the appropriate API Endpoint.

Whenever events are generated, Radar will send custom events and user attributes to Braze. Events and user attributes from iOS devices will be sent using your iOS app identifiers, and events and user attributes from Android devices will be sent using your Android app identifiers.

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)

User mapping#

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"`
`locationAuthorization`	`radar_location_authorization`	string	`"GRANTED_FOREGROUND"`
`locationAccuracyAuthorization`	`radar_location_accuracy_authorization`	string	`"FULL"`
`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
`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
`trip.externalId`	`radar_trip_external_id`	string	`"299"`	Trip Tracking
`trip.destinationGeofenceTag`	`radar_trip_destination_geofence_tag`	string	`"store"`	Trip Tracking
`trip.destinationGeofenceExternalId`	`radar_trip_destination_geofence_external_id`	string	`"123"`	Trip Tracking
`beacons[*]._id`	`radar_beacon_ids`	array[string]	`["5b2c0906f5874b001aecfd8f]"`	Beacons
`beacons[*].description`	`radar_beacon_descriptions`	array[string]	`["Store #123 - Drive-Thru"]`	Beacons
`beacons[*].tag`	`radar_beacon_tags`	array[string]	`["drive-thru"]`	Beacons
`beacons[*].externalId`	`radar_beacon_external_ids`	array[string]	`["123"]`	Beacons