Radar supports a number of server-side integrations. Event integrations like webhooks, mParticle, and Braze allow you to send events from Radar to other systems. Geofence integrations like geofence sync and Yext allow you to sync geofences from other systems to Radar.
Event integrations allow you to send events from Radar to other systems.
You can use webhooks to send events and user state from Radar to your server, a Google or Firebase Cloud Function, an AWS Lambda Function, or any HTTP endpoint. From there, you can store events and user state in a database, send them to a marketing automation or analytics platform, and more.
Webhooks are a basic integration, available to Free and Enterprise customers.
Create a webhook on the Radar Integrations page under Webhooks. For Environment, choose Test to receive callbacks for events in the Test environment, or choose Live to receive callbacks for events in the Live environment. For Event Delivery, choose Single Event to receive a single event in each request, or choose Multiple Events to receive multiple events in each request when events occur simultaneously. Finally, enter a URL.
Whenever events are generated, Radar will send a POST request containing event and user data to the specified URL. You can also click the Test button to send test event and user data. If you chose Single Event, the request body will contain an event dictionary and a user dictionary. If you chose Multiple Events, the request body will contain an events array and a user dictionary.
To acknowledge receipt of the request, your webhook should return a 2xx status code (e.g., 200 OK, 201 Created, or 202 Accepted).
{
"events": [
{
"_id": "56db1f4613012711002229f6",
"type": "user.entered_geofence",
"createdAt": "2018-06-12T13:44:10.535Z",
"live": true,
"user": {
"userId": "1",
"deviceId": "C305F2DB-56DC-404F-B6C1-BC52F0B680D8",
"metadata": {
"customId": "abc",
"customFlag": false
}
},
"geofence": {
"tag": "store",
"externalId": "123",
"description": "Store #123",
"metadata": {
"parking": false
}
},
"location": {
"type": "Point",
"coordinates": [
-73.977797,
40.783826
]
},
"locationAccuracy": 5,
"confidence": 3
},
{
"_id": "56db1f4613012711002229f7",
"type": "user.entered_place",
"createdAt": "2018-06-12T13:44:10.535Z",
"live": true,
"user": {
"_id": "56db1f4613012711002229f4",
"userId": "1",
"deviceId": "C305F2DB-56DC-404F-B6C1-BC52F0B680D8",
"metadata": {
"customId": "abc",
"customFlag": false
}
},
"place": {
"name": "Starbucks",
"chain": {
"name": "Starbucks",
"slug": "starbucks",
"externalId": "123",
"metadata": {
"customFlag": true
}
},
"categories": [
"food-beverage",
"coffee-shop"
],
"location": {
"type": "Point",
"coordinates": [
-73.977797,
40.783826
]
}
},
"location": {
"type": "Point",
"coordinates": [
-73.977797,
40.783826
]
},
"locationAccuracy": 5,
"confidence": 2
}
],
"user": {
"_id": "56db1f4613012711002229f4",
"live": true,
"userId": "1",
"deviceId": "C305F2DB-56DC-404F-B6C1-BC52F0B680D8",
"metadata": {
"customId": "abc",
"customFlag": false
},
"updatedAt": "2018-06-12T13:44:10.535Z",
"createdAt": "2018-06-10T11:23:58.741Z",
"location": {
"type": "Point",
"coordinates": [
-73.977797,
40.783826
]
},
"locationAccuracy": 5,
"stopped": true,
"foreground": false,
"deviceType": "iOS",
"ip": "173.14.0.1",
"geofences": [
{
"tag": "store",
"externalId": "123",
"description": "Store #123",
"metadata": {
"parking": false
}
}
],
"place": {
"name": "Starbucks",
"chain": {
"name": "Starbucks",
"slug": "starbucks"
},
"categories": [
"food-beverage",
"coffee-shop"
],
"location": {
"type": "Point",
"coordinates": [
-73.977797,
40.783826
]
}
},
"insights": {
"state": {
"home": false,
"office": false,
"traveling": true,
"commuting": false
}
},
"country": {
"code": "US",
"name": "United States",
"flag": "🇺🇸"
},
"state": {
"code": "MD",
"name": "Maryland"
},
"dma": {
"code": "26",
"name": "Baltimore"
},
"postalCode": {
"code": "21014",
"name": "21014"
},
"segments": [
{
"description": "Starbucks Visitors",
"externalId": "starbucks-visitors"
}
],
"topChains": [
{
"name": "Starbucks",
"slug": "starbucks",
"externalId": "123"
},
{
"name": "Walmart",
"slug": "walmart",
"externalId": "456"
}
],
"fraud": {
"proxy": false,
"mocked": false
}
}
}Each webhook has a random security token. The authenticity of a request made to a webhook URL can be verified using the X-Radar-Signature header. If you chose Single Event, the header will contain an HMAC-SHA1 hash of the event ID using the security token as the key. If you chose Multiple Events, the header will contain an HMAC-SHA1 hash of the first event ID using the security token as the key.
Note that you can also receive events client-side via the SDK.
Radar can send events and user traits to Segment as a source. Segment can send those events and user traits to your warehouse and to hundreds of destinations.
Segment is a premium integration, available only to Enterprise customers.
In Segment, add Radar as a source and copy your write key.
Then, on the Radar Integrations page under Segment Source, set Enabled to Yes and paste your write key. Note that you can set separate write keys for the Test and Live environments.
Whenever events are generated, Radar will call track and identify to send events and user traits to Segment.
By default, Radar userId maps to Segment userId for logged in users, and Radar deviceId maps to Segment anonymousId for logged out users. However, you can specify custom mappings by setting Radar metadata.segmentUserId or metadata.segmentAnonymousId. For example, on iOS:
// track logged out users with custom anonymousId mapping (not required if using default mapping)
Radar.setMetadata(["segmentAnonymousId": anonymousId])
// track logged in users with custom userId mapping (not required if using default mapping)
Radar.setMetadata(["segmentUserId": userId])See the full list of event and user trait mappings in the Segment integration reference.
Radar can send events and user attributes to mParticle as an input feed. You can use events and user attributes to build audiences in mParticle, and mParticle can send events and user attributes to hundreds of outputs.
The mParticle SDK can also install and initialize the Radar SDK as a kit.
mParticle is a premium integration, available only to Enterprise customers.
To configure the feed, in mParticle, add Radar input feeds for iOS and Android and copy your API keys and secrets.
Then, on the Radar Integrations page under mParticle Feed, set Enabled to Yes and paste your API keys and secrets.
Whenever events are generated, Radar will send events and user attributes to mParticle. Events and user attributes from iOS devices will be sent to the iOS input feed, and events and user attributes from Android devices will be sent to the Android input feed. The Radar Test environment automatically maps to the Development environment in mParticle, and the Radar Live environment automatically maps to the Production environment in mParticle.
By default, Radar userId maps to mParticle customerid for logged in users. However, you can specify a custom mapping by setting Radar metadata.mParticleCustomerId. For example, on iOS:
// track logged in users with custom userId mapping (not required if using default mapping)
Radar.setMetadata(["mParticleCustomerId": customerid])See the full list of event and user attribute mappings in the mParticle integration reference.
To configure the kit, on the Radar Settings page under Keys, copy your test and live publishable keys. Then, in mParticle, add and enable Radar outputs for iOS and Android, paste your keys, and choose whether to run automatically.
Install the kit using CocoaPods or Carthage on iOS and Gradle on Android. See the iOS kit code and readme, Android kit code and readme, and mParticle Kit documentation for Radar.
The kit will initialize the Radar SDK and identify the user with the mParticle customer ID. In addition, if you chose to run automatically and the user has granted permissions, the kit will automatically track the user's location in the foreground on app open and/or in the background.
Radar can send events and user state to Lytics.
Lytics is a premium integration, available only to Enterprise customers.
Before enabling the integration, contact your Lytics account manager. After Lytics is configured, in Lytics, create an API token with no expiration and the Data Manager role.
Then, on the Radar Integrations page under Lytics, set Enabled to Yes, paste your API token. Note that you can set separate API tokens and stream names for the Test and Live environments.
Whenever events are generated, Radar will send events to the radar_events stream and user state to the radar_users stream.
See the full list of event and user state mappings in the Lytics integration reference.
Radar can send events and user attributes to Braze.
Braze is a premium integration, available only to Enterprise customers.
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)See the full list of event and user attribute mappings in the Braze integration reference.
Radar can send events and tags to Airship.
Airship is a premium integration, available only to Enterprise customers.
On the Airship APIs & Integrations page, create a custom event token and copy the app key and access token. Under Partner Integrations, enable Radar to enable auto-population of custom event names and properties in the Airship Automation Composer.
Then, on the Radar Integrations page under Urban Airship, set Enabled to Yes and paste your app key and access token. Note that you can set separate API keys for the Test and Live environments.
Whenever events are generated, Radar will send custom events and tags to Airship. Note that for tags to populate, you must manually create tag groups in Airship first.
See the full list of tag and event mappings in the Airship integration reference.
Radar can send events and user attributes to Leanplum.
Leanplum is a premium integration, available only to Enterprise customers.
On the Leanplum App Settings page, click Keys & Settings and copy the App ID, Production Key, and Development Key.
Then, on the Radar Integrations page under Leanplum, set Enabled to Yes and paste the app ID and API keys. The Radar Test environment automatically maps to the Development environment in Leanplum, and the Radar Live environment automatically maps to the Production environment in Leanplum.
Whenever events are generated, Radar will call track and setUserAttributes to send events and user attributes to Leanplum.
See the full list of event and user attribute mappings in the Leanplum integration reference.
Radar can send events and user data to Iterable.
On the Iterable API Keys page, create and copy a Mobile API key.
Then, on the Radar Integrations page under Iterable, set Enabled to Yes and paste your key. Note that you can set separate keys for the Test and Live environments.
Whenever events are generated, Radar will send custom events and user data to Iterable.
See the full list of event and user property mappings in the Iterable integration reference.
Radar can send events to Salesforce Marketing Cloud to trigger journeys in Journey Builder.
On the Salesforce Marketing Cloud Installed Packages page, click New. Add an installed package with the name Radar. On the package details page, add an API Integration component with the Server-to-Server integration type and all permissions for the Automation, Contacts, Cross Cloud Platform, and Data scopes. Copy your Client ID, Client Secret, Authentication Base URI, and REST Base URI.
Then, on the Radar Integrations page under Salesforce Marketing Cloud, set Enabled to Yes and paste these values. When you click Save, Radar will create an event definition and data extension with the specified event definition key (radar-event by default).
Finally, in the Salesforce Marketing Cloud Journey Builder, create a new journey with an API Event entry source using this event definition and data extension.
By default, Radar userId maps to Salesforce Marketing Cloud contactKey for logged in users. However, you can track logged out users or specify custom mappings by setting Radar metadata.salesforceContactKey. For example, on iOS:
Radar.setMetadata(["salesforceContactKey": contactKey])Whenever events are generated, Radar will send events to your Salesforce Marketing Cloud data extension to trigger journeys.
See the full list of event mappings in the Salesforce Marketing Cloud integration reference.
Radar can send events and user properties to Amplitude.
Amplitude is a premium integration, available only to Enterprise customers.
On the Amplitude Manage Project page, copy your API key.
Then, on the Radar Integrations page under Amplitude, set Enabled to Yes and paste your API key. Note that you can set separate API keys for the Test and Live environments.
Whenever events are generated, Radar will send events and user properties to Amplitude.
See the full list of event and user property mappings in the Amplitude integration reference.
Radar can send events and user properties to Mixpanel.
Mixpanel is a premium integration, available only to Enterprise customers.
On the Mixpanel Project Settings page, copy the token from the Management tab. Then, on the Radar Integrations page under Mixpanel, set Enabled to Yes and paste your token. Note that you can set separate tokens for the Test and Live environments.
Whenever events are generated, Radar will send custom events and user properties to Mixpanel.
By default, Radar userId maps to Mixpanel distinct ID for logged in users. However, you can specify a custom mapping by setting Radar metadata.mixpanelDistinctId. For example, on iOS:
Radar.setMetadata(["mixpanelDistinctId": distinctIdValue])See the full list of event and user property mappings in the Mixpanel integration reference.
Radar can send tags to and trigger notifications in OneSignal.
OneSignal is a premium integration, available only to Enterprise customers.
On the OneSignal Settings page under Keys & IDs, copy your REST API key.
Then, on the Radar Integrations page under OneSignal, set Enabled to Yes and paste your API key. Note that you can set separate API keys for the Test and Live environments.
Whenever events are generated, Radar will call the edit device API and set tags in OneSignal. You can create notifications triggered by tag changes.
By default, Radar userId and deviceId do not map to OneSignal. To map users in Radar to devices in OneSignal, you must send the OneSignal player ID to Radar by setting metadata.oneSignalPlayerId. For example, on iOS:
let playerId = OneSignal.getPermissionSubscriptionState().subscriptionStatus.userId
Radar.setMetadata(["oneSignalPlayerId": playerId])On Android:
String playerId = OneSignal.getPermissionSubscriptionState().getSubscriptionStatus().getUserId();
JSONObject metadata = new JSONObject();
metadata.put("oneSignalPlayerId", playerId);
Radar.setMetadata(metadata);See the full list of tag mappings in the OneSignal integration reference.
Radar can send events to Branch.
Branch is a premium integration, available only to Enterprise customers.
On the Branch Account Settings page under Profile, copy your Branch key.
Then, on the Radar Integrations page under Branch, set Enabled to Yes and paste your key. Note that you can set separate keys for the Test and Live environments.
Whenever events are generated, Radar will send custom events to Branch.
Radar sends adId (iOS IDFA, Android advertising ID) and deviceId (iOS IDFV, Android ID) to Branch. On SDK v3 and higher, you must manually enable adId collection. For example, on iOS:
Radar.setAdIdEnabled(true)See the full list of event mappings in the Branch integration reference.
Click Show Advanced on the Integrations page under an integration to show advanced filters.
To filter event types sent to an integration, select or unselect event types under Event Type Whitelist.
To filter keys from the request body sent to an integration, add keys, comma-separated, to Request Key Blacklist. For example, to skip sending radar_geofence_ids to the Segment identify call and to skip sending geofence_id to the Segment track call, add radar_geofence_ids,geofence_id to Request Key Blacklist.
Geofence integrations allow you to sync geofences from other systems to Radar.
Radar can automatically sync geofences nightly from CSVs.
Geofence sync is a premium integration, available only to Enterprise customers.
On the Radar Integrations page under Geofence Sync, set Enabled to Yes. Enter a Notification Email to receive success and failure confirmation emails. Then, choose a Protocol:
GetObject permissions for the specified S3 bucket and objects.Note that you can set separate CSVs for the Test and Live environments.
The geofence sync CSV format is the same as the geofence import CSV format.
When you click Save and Sync, Radar will attempt a one-time sync and send an email on success or failure. Radar will then attempt syncs nightly.
Radar can sync locations from Brandify as geofences in Radar, powered by geofence sync.
Brandify is a premium integration, available only to Enterprise customers. To
Ask your Brandify account manager to enable a published CSV of your locations as Radar geofences. Then, on the Radar Integrations page under Geofence Sync, set Enabled to Yes. Enter the published CSV URL. Note that you can set separate URLs for the Test and Live environments.
The geofence sync CSV format is the same as the geofence import CSV format.
When you click Save and Sync, Radar will attempt a one-time sync and send an email on success or failure. Radar will then attempt syncs nightly.
Radar can sync locations from Yext as geofences in Radar.
Yext is a premium integration, available only to Enterprise customers.
On the Radar Integrations page under Yext, click Connect. You will be redirected to Yext, where you can authorize Radar. If authorization succeeds, you will be redirected to the Radar Geofences page. If authorization fails, you will be redirected back to the Radar Integrations page.
Radar will automatically sync all locations from Yext as geofences in Radar, and keep geofences in sync when you create or update locations in Yext. By default, Radar will map Yext location name to geofence description, set location as geofence tag, map Yext store ID to geofence externalId, map other Yext metadata to geofence metadata, set radius to 100 meters, and set enabled to false if the location is closed in Yext. Radar will sync geofences both to the Test and Live environments.
To change any of these defaults, please contact support.