Detections
The Detections webhook event provides real-time updates on detected people's locations, represented by coordinates (x, y) within a sensor's field of view.
Payload
The Detections event follows a standardized JSON structure:
Field Descriptions
Event Metadata
id
string
Unique event identifier
type
string
Event type (e.g., "detections")
timestamp
number
Timestamp of the event (in milliseconds)
version
string
Event version (e.g., "v1.0.0")
Organization and Location Metadata
org_id
string
Unique organization identifier
site_id
string
Unique site identifier
building_id
string
Unique building identifier
floor_id
string
Unique floor identifier
room_id
string (optional)
Unique room identifier
hive_id
string
Unique hive identifier
sensor_id
string
Unique sensor identifier
org_name
string
Organization name
site_name
string
Site name
building_name
string
Building name
floor_name
string
Floor name
room_name
string (optional)
Room name
hive_serial
string
Hive serial number
mac_address
string
Sensor MAC address
sensor_mode
string
Sensor mode (e.g., "presence")
sensor_model
string
Sensor's model (e.g., "Heatic 2+", "Heatic 2")
hive_model
string
Hive's model (e.g., "2.0", "1.0")
hive_version
string
Hive's software version
Detection Data
local
array[array[number, number]]
Array of detected people's coordinates (x, y), relative to the sensor's field of view
world
array[array[number, number]]
Array of detected people's coordinates (x, y), relative to the floor's coordinates
Last updated