Skip to main content

Attentive

Radar can send events and user attributes to Attentive.

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

Configuration#

After logging in to the Attentive console, go to Marketplace and click Create app. Fill out the form to create your app, making sure to include the Write permission for Custom Events. Other permissions such as Subscribers, Custom Attributes, and Identity might be needed to assign users to subscription channels and modify their identifiers.

Then, on the Radar Integrations page under Attentive, 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 custom events and user mappings to Attentive. Once Attentive is receiving Radar custom events, set up a Segment or Journey to create triggers from those events to send messages.

By default, Radar userId maps to Attentive clientUserId. However, you can specify custom mappings by setting Radar metadata.attentiveUserId. For example, on iOS:

// track users with a custom userId mapping (not required if using default mapping)Radar.setMetadata(["attentiveUserId": userId])

Event mapping#

user.entered_geofence#

Radar Event FieldAttentive Event PropertyTypeExample Value
geofence._idgeofence_idstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofence_descriptionstring"Store #123"
geofence.taggeofence_tagstring"store"
geofence.externalIdgeofence_external_idstring"123"
geofence.metadata[{key}]geofence_metadata_{key}{type}{value}
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

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

Radar Event FieldAttentive Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

user.exited_geofence#

Radar Event FieldAttentive Event PropertyTypeExample Value
geofence._idgeofence_idstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofence_descriptionstring"Store #123"
geofence.taggeofence_tagstring"store"
geofence.externalIdgeofence_external_idstring"123"
geofence.metadata[{key}]geofence_metadata_{key}{type}{value}
confidenceconfidencestring"high"
durationdurationnumber (minutes)42.1
foregroundforegroundbooleantrue

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

Radar Event FieldAttentive Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

user.dwelled_in_geofence#

Radar Event FieldAttentive Event PropertyTypeExample Value
geofence._idgeofence_idstring"5b2c0906f5874b001aecfd8e"
geofence.descriptiongeofence_descriptionstring"Store #123"
geofence.taggeofence_tagstring"store"
geofence.externalIdgeofence_external_idstring"123"
geofence.metadata[{key}]geofence_metadata_{key}{type}{value}
confidenceconfidencestring"high"
durationdurationnumber (minutes)5
foregroundforegroundbooleantrue

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

Radar Event FieldAttentive Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

user.entered_place#

Radar Event FieldAttentive Event PropertyTypeExample Value
place._idplace_idstring"59302bcf8f27e8a156bd4f91"
place.nameplace_namestring"Starbucks"
place.chain.slugplace_chain_idstring"starbucks"
place.chain.nameplace_chain_namestring"Starbucks"
place.chain.externalIdplace_chain_external_idstring"123"
place.chain.metadata[{key}]place_chain_metadata_{key}{type}{value}
place.categoriesplace_categoriesstring (comma-separated)"food-beverage,cafe,coffee-shop"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

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

Radar Event FieldAttentive Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

user.exited_place#

Radar Event FieldAttentive Event PropertyTypeExample Value
place._idplace_idstring"59302bcf8f27e8a156bd4f91"
place.nameplace_namestring"Starbucks"
place.chain.slugplace_chain_idstring"starbucks"
place.chain.nameplace_chain_namestring"Starbucks"
place.chain.externalIdplace_chain_external_idstring"123"
place.chain.metadata[{key}]place_chain_metadata_{key}{type}{value}
place.categoriesplace_categoriesstring (comma-separated)"food-beverage,cafe,coffee-shop"
confidenceconfidencestring"high"
durationdurationnumber (minutes)42.1
foregroundforegroundbooleantrue

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

Radar Event FieldAttentive Event PropertyTypeExample Value
country.codecountry_codestring"US"
country.namecountry_namestring"United States"
state.codestate_codestring"MD"
state.namestate_namestring"Maryland"
dma.codedma_codestring"26"
dma.namedma_namestring"Baltimore"
postalCode.codepostal_codestring"21014"

user.entered_country#

Radar Event AttributeAttentive Event PropertyTypeExample Value
region.coderegion_codestring"US"
region.nameregion_namestring"United States"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.exited_country#

Radar Event AttributeAttentive Event PropertyTypeExample Value
region.coderegion_codestring"US"
region.nameregion_namestring"United States"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.entered_state#

Radar Event AttributeAttentive Event PropertyTypeExample Value
region.coderegion_codestring"MD"
region.nameregion_namestring"Maryland"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.exited_state#

Radar Event AttributeAttentive Event PropertyTypeExample Value
region.coderegion_codestring"MD"
region.nameregion_namestring"Maryland"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.entered_dma#

Radar Event AttributeAttentive Event PropertyTypeExample Value
region.coderegion_codestring"26"
region.nameregion_namestring"Baltimore"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.exited_dma#

Radar Event AttributeAttentive Event PropertyTypeExample Value
region.coderegion_codestring"26"
region.nameregion_namestring"Baltimore"
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.started_trip#

Radar Event AttributeAttentive Event PropertyTypeExample Value
trip.externalIdtrip_external_idstring"299"
trip.metadata[{key}]trip_metadata_{key}{type}{value}
trip.destinationGeofenceTagtrip_destination_geofence_tagstring"store"
trip.destinationGeofenceExternalIdtrip_destination_geofence_external_idstring"123"
foregroundforegroundbooleantrue

user.updated_trip#

Radar Event AttributeAttentive Event PropertyTypeExample Value
trip.externalIdtrip_external_idstring"299"
trip.metadata[{key}]trip_metadata_{key}{type}{value}
trip.destinationGeofenceTagtrip_destination_geofence_tagstring"store"
trip.destinationGeofenceExternalIdtrip_destination_geofence_external_idstring"123"
foregroundforegroundbooleantrue

user.approaching_trip_destination#

Radar Event AttributeAttentive Event PropertyTypeExample Value
trip.externalIdtrip_external_idstring"299"
trip.metadata[{key}]trip_metadata_{key}{type}{value}
trip.destinationGeofenceTagtrip_destination_geofence_tagstring"store"
trip.destinationGeofenceExternalIdtrip_destination_geofence_external_idstring"123"
foregroundforegroundbooleantrue

user.arrived_at_trip_destination#

Radar Event AttributeAttentive Event PropertyTypeExample Value
trip.externalIdtrip_external_idstring"299"
trip.metadata[{key}]trip_metadata_{key}{type}{value}
trip.destinationGeofenceTagtrip_destination_geofence_tagstring"store"
trip.destinationGeofenceExternalIdtrip_destination_geofence_external_idstring"123"
foregroundforegroundbooleantrue

user.stopped_trip#

Radar Event AttributeAttentive Event PropertyTypeExample Value
trip.externalIdtrip_external_idstring"299"
trip.metadata[{key}]trip_metadata_{key}{type}{value}
trip.destinationGeofenceTagtrip_destination_geofence_tagstring"store"
trip.destinationGeofenceExternalIdtrip_destination_geofence_external_idstring"123"
foregroundforegroundbooleantrue

user.entered_beacon#

Radar Event AttributeAttentive Event PropertyTypeExample Value
beacon._idbeacon_idstring"5b2c0906f5874b001aecfd8f"
beacon.descriptionbeacon_descriptionstring"Store #123 - Drive-Thru"
beacon.tagbeacon_tagstring"drive-thru"
beacon.externalIdbeacon_external_idstring"123"
beacon.metadata[{key}]trip_metadata_{key}{type}{value}
confidenceconfidencestring"high"
foregroundforegroundbooleantrue

user.exited_beacon#

Radar Event AttributeAttentive Event PropertyTypeExample Value
beacon._idbeacon_idstring"5b2c0906f5874b001aecfd8f"
beacon.descriptionbeacon_descriptionstring"Store #123 - Drive-Thru"
beacon.tagbeacon_tagstring"drive-thru"
beacon.externalIdbeacon_external_idstring"123"
beacon.metadata[{key}]beacon_metadata_{key}{type}{value}
confidenceconfidencestring"high"
durationradar_durationnumber (minutes)1.42
foregroundforegroundbooleantrue