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:

{
  "id": "event_2oUBiSXgx48RtbZKXHm5ekpAzFe",
  "type": "DETECTIONS",
  "timestamp": 1727735832000,
  "version": "v1.0.0",
  "metadata": {
    "org_id": "org_2oUBiRES2AmpczNM5yLu7pChz8o",
    "site_id": "site_2oUBkdxF0lLJZxyWVix09ZTsMNV",
    "building_id": "building_2oUBkaFkcYwDzo7HLXpPh8bP4cD",
    "floor_id": "space_2oUBnI7YL51GNemTvKIxEgSZ8gx",
    "room_id": "room_2oUDDps5iKHHo6RwlMgGVihmTlq", // (optional)
    "hive_id": "hive_2oULLOWeATbeC4Ebfe849hNlFWk",
    "sensor_id": "2oULMisdkRfEp6mBag2gLpJ0d7Z",
    "org_name": "Murphy Group",
    "site_name": "Los Angeles",
    "building_name": "Bergnaum Building",
    "floor_name": "1st Floor",
    "room_name": "Cherry Falls", // (optional)
    "hive_serial": "21312f639defabc0",
    "mac_address": "00-17-0d-00-00-cc-bb-aa",
    "sensor_mode": "presence",
    "sensor_model": "Heatic 2+",
    "hive_model": "2.0",
    "hive_version": "2.4.4"
  },
  "data": {
    "local": [ [0.5625, 0.125], [0.75, 0.5625] ], // 2 detections
    "world": [ [85.694195, 27.829299], [87.439295, 28.577199]] // 2 detections
  }
}

Field Descriptions

Event Metadata

Field
Type
Description

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

Field
Type
Description

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

Field
Type
Description

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