Zone Occupancy
The Zone Occupancy webhook event provides real-time updates on the number of occupants detected by the presence sensor on a specific zone.
Please note that we recompute occupancy data at every 1-minute cadence, looking back a few minutes to account for potential delays. This will result in repeated data for a rolling 5-minute window. You can expect duplicate events, updated occupancy counts for previous minutes and possible discrepancies between initial and recomputed values. When processing events, consider storing unique timestamps, using the latest data and implementing deduplication or caching mechanisms.
Payload
The Zone Occupancy event follows a standardized JSON structure:
Field Descriptions
Event Metadata
id
string
Unique event identifier
type
string
Event type (e.g., "zone_occupancy")
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
zone_id
string
Unique zone 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
zone_name
string
Zone name
Occupancy Data
data
number
Current occupancy count on the room
Last updated