Butlr Developer Docs
  • Welcome
  • What is Butlr
  • Spatial Metrics
  • Getting Started
    • Authentication
    • Making your first query
    • Mint Client Credentials
  • Changelog
  • Asset Management
    • GraphQL API Overview
      • Sites
      • Buildings
      • Floors
      • Rooms
      • Zones
      • Hives
      • Sensors
      • Asset Tags
    • GraphQL API Introsepction
  • Historical Occupancy
    • Reporting API Overview
      • Floor Occupancy
      • Room Occupancy
      • Zone Occupancy
      • Query Occupancy by Tag
      • Traffic
      • Presence Time
      • Statistic Overview
    • FAQs
  • Real-time occupancy
    • Webhooks Overview
      • Area Detections
      • Entryway Traffic
      • Floor Occupancy
      • Room Occupancy
      • Zone Occupancy
      • Motion Detection
      • No Motion Detection
    • Manage Webhooks
      • Create Webhooks
      • Update Webhooks
      • Delete Webhooks
      • List Webhooks
  • LINKS
    • Butlr Postman Collection
    • Butlr Website
    • Status
    • Support
    • Log In
Powered by GitBook
On this page
  • Payload
  • Field Descriptions
  1. Real-time occupancy
  2. Webhooks Overview

Entryway Traffic

The Traffic webhook event provides real-time updates whenever someone enters or exits a monitored area.

Payload

The Traffic event follows a standardized JSON structure:

{
  "id": "event_2oUBiSXgx48RtbZKXHm5ekpAzFe",
  "type": "TRAFFIC",
  "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)
    "floor_custom_id": "2tZStWPtxqpmb3w0PoJDm7AnfIX", // (optional)
    "room_custom_id": "2tZSGplhA4CZ58wFlTf7wAeKMVo",  // (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": "traffic",
    "sensor_model": "Heatic 2+",
    "hive_model": "2.0",
    "hive_version": "2.4.4"
  },
  "data": {
    "in": 0,
    "out": 1
  }
}

Field Descriptions

Event Metadata

Field
Type
Description

id

string

Unique event identifier

type

string

Event type (e.g., "traffic")

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

floor_custom_id

string (optional)

Customer's unique floor identifier

room_custom_id

string (optional)

Customer's 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., "traffic")

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

Traffic Data

Field
Type
Description

in

number

Number of people entering the area

out

number

Number of people exiting the area

PreviousArea DetectionsNextFloor Occupancy

Last updated 2 months ago