Airship Integration Reference

Contents

Introduction

Whenever events are generated, Radar will send custom events to Airship. The full list of supported events is below.

Event mapping

Radar Event Context Type Airship Event
user.entered_geofence Geofences radar_geofence_entered
user.exited_geofence Geofences radar_geofence_exited
user.entered_place Places radar_place_entered
user.exited_place Places radar_place_exited
user.entered_home Insights radar_home_entered
user.exited_home Insights radar_home_exited
user.entered_office Insights radar_office_entered
user.exited_office Insights radar_office_exited
user.started_traveling Insights radar_traveling_started
user.stopped_traveling Insights radar_traveling_stopped
user.entered_region_country Regions radar_country_entered
user.exited_region_country Regions radar_country_exited
user.entered_region_state Regions radar_state_entered
user.exited_region_state Regions radar_state_exited
user.entered_region_dma Regions radar_dma_entered
user.exited_region_dma Regions radar_dma_exited

radar_geofence_entered

Radar Event Field Airship Event Property Type Example Value
geofence._id radar_geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description radar_geofence_description string "Store #123"
geofence.tag radar_geofence_tag string "store"
geofence.externalId radar_geofence_external_id string "123"
geofence.metadata[{key}] radar_geofence_metadata_{key} {type} {value}
confidence radar_confidence string "high"

radar_geofence_exited

Radar Event Field Airship Event Property Type Example Value
geofence._id radar_geofence_id string "5b2c0906f5874b001aecfd8e"
geofence.description radar_geofence_description string "Store #123"
geofence.tag radar_geofence_tag string "store"
geofence.externalId radar_geofence_external_id string "123"
geofence.metadata[{key}] radar_geofence_metadata_{key} {type} {value}
confidence radar_confidence string "high"
duration radar_duration number (minutes) 42.1

radar_place_entered

Radar Event Field Airship Event Property Type Example Value
place._id radar_place_id string "59302bcf8f27e8a156bd4f91"
place.name radar_place_name string "Starbucks"
place.chain.slug radar_place_chain_id string "starbucks"
place.chain.name radar_place_chain_name string "Starbucks"
place.categories radar_place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence radar_confidence string "high"

radar_place_exited

Radar Event Field Airship Event Property Type Example Value
place._id radar_place_id string "59302bcf8f27e8a156bd4f91"
place.name radar_place_name string "Starbucks"
place.chain.slug radar_place_chain_id string "starbucks"
place.chain.name radar_place_chain_name string "Starbucks"
place.categories radar_place_categories string (comma-separated) "food-beverage,cafe,coffee-shop"
confidence radar_confidence string "high"
duration radar_duration number (minutes) 42.1

radar_home_entered

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_home_exited

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_office_entered

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_office_exited

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_traveling_started

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_traveling_stopped

Radar Event Field Airship Event Property Type Example Value
confidence radar_confidence string "high"

radar_country_entered

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "US"
region.name radar_region_name string "United States"
confidence radar_confidence string "high"

radar_country_exited

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "US"
region.name radar_region_name string "United States"
confidence radar_confidence string "high"

radar_state_entered

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "MD"
region.name radar_region_name string "Maryland"
confidence radar_confidence string "high"

radar_state_exited

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "MD"
region.name radar_region_name string "Maryland"
confidence radar_confidence string "high"

radar_dma_entered

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "26"
region.name radar_region_name string "Baltimore"
confidence radar_confidence string "high"

radar_dma_exited

Radar Event Attribute Airship Event Property Type Example Value
region.code radar_region_code string "26"
region.name radar_region_name string "Baltimore"
confidence radar_confidence string "high"