Iterable Integration Reference

Contents

Introduction

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

User mapping

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

Radar User Field Iterable User Data Field Type Example Value
userId userId string "1"
location.coordinates[0] radarLocationLongitude number -76.350663
location.coordinates[1] radarLocationLatitude number 39.525665
_id radarId string "5b2c0906f5874b001aecfd8d"
updatedAt radarUpdatedAt timestamp "2018-06-22T15:23:39.000Z"
geofences[]._id radarGeofenceIds array[string] ["5b2c0906f5874b001aecfd8e"]
geofences[].description radarGeofenceDescriptions array[string] ["Bel Air"]
geofences[].tag radarGeofenceTags array[string] ["city"]
geofences[].externalId radarGeofenceExternalIds array[string] ["bel-air"]
place._id radarPlaceId string "59302bcf8f27e8a156bd4f91"
place.name radarPlaceName string "Target Bel Air"
place.facebookId radarPlaceFacebookId string "141162456060553"
place.categories radarPlaceCategories array[string] ["shopping-retail"]
place.chain.slug radarPlaceChainSlug string "target"
place.chain.name radarPlaceChainName string "Target"
insights.state.home radarInsightsStateHome boolean false
insights.state.office radarInsightsStateOffice boolean false
insights.state.traveling radarInsightsStateTraveling boolean true

Event mapping

Radar Event Iterable Event
user.entered_geofence radarGeofenceEntered
user.exited_geofence radarGeofenceExited
user.entered_place radarPlaceEntered
user.exited_place radarPlaceExited
user.entered_home radarHomeEntered
user.exited_home radarHomeExited
user.entered_office radarOfficeEntered
user.exited_office radarOfficeExited
user.started_traveling radarTravelingStarted
user.stopped_traveling radarTravelingStopped

radarGeofenceEntered

Radar Event Field Iterable Event Data Field Type Example
geofence._id geofenceId string "5b2c0906f5874b001aecfd8e"
geofence.description geofenceDescription string "Bel Air"
geofence.tag geofenceTag string "city"
geofence.externalId geofenceExternalId string "bel-air"
confidence confidence string "high"

radarGeofenceExited

Radar Event Field Iterable Event Data Field Type Example
geofence._id geofenceId string "5b2c0906f5874b001aecfd8e"
geofence.description geofenceDescription string "Bel Air"
geofence.tag geofenceTag string "city"
geofence.externalId geofenceExternalId string "bel-air"
confidence confidence string "high"
duration duration number (minutes) 42.1

radarPlaceEntered

Radar Event Field Iterable Event Data Field Type Example
place._id placeId string "59302bcf8f27e8a156bd4f91"
place.name placeName string "Target Bel Air"
place.facebookId placeFacebookId string "141162456060553"
place.chain.slug placeChainSlug string "target"
place.chain.name placeChainName string "Target"
place.categories placeCategories array[string] ["shopping-retail"]
confidence confidence string "high"

radarPlaceExited

Radar Event Field Iterable Event Data Field Type Example
place._id placeId string "59302bcf8f27e8a156bd4f91"
place.name placeName string "Target Bel Air"
place.facebookId placeFacebookId string "141162456060553"
place.chain.slug placeChainSlug string "target"
place.chain.name placeChainName string "Target"
place.categories placeCategories array[string] ["shopping-retail"]
confidence confidence string "high"
duration duration number (minutes) 42.1

radarHomeEntered

Radar Event Field Iterable Event Data Field Type Example
confidence confidence string "high"

radarHomeExited

Radar Event Field Iterable Event Data Field Type Example
confidence confidence string "high"

radarOfficeEntered

Radar Event Field Iterable Event Data Field Type Example
confidence confidence string "high"

radarOfficeExited

Radar Event Field Iterable Event Data Field Type Example
confidence confidence string "high"

radarTravelingStarted

Radar Event Field Iterable Event Data Field Type Example
confidence confidence string "high"

radarTravelingStopped

Radar Event Field Iterable Event Data Field Type Example
confidence confidence string "high"