Connect Butlr to KODE OS for occupancy data integration
Overview
Use this integration to connect Butlr occupancy sensors to KODE OS. You can discover zones and devices, receive pushed webhook updates for live conditions, and map people counts, heatmaps, and zone occupancy into your building graph for analytics and operations.Supported Capabilities
- Discover Devices & Points
- Collect Sensor Data
- Collect Non-Sensor Data
- Receive Webhook Data
- Collect Historical Data
Prerequisites
To integrate with the Butlr API, ensure you have the following details:- An active account in https://app.butlr.io with the appropriate access permissions.
- Valid username and password credentials for Butlr platform.
Generate API Credentials
- Go to the Butlr Web App.
- Sign in using your username and password.
- Click the expandable menu (v) in the top navigation bar (upper right corner) and select Account Settings.
- Navigate to the API tokens tab.
- Click the Create token button.
- Enter a Name and a Description, then click Create.
- A dialog box will display your Client ID and Client Secret. After completing the steps above, your Client ID and Client Secret will be used in the next step. ⬇️
Configure Webhook
This integration uses webhooks for real-time data delivery. After creating the connector in KODE OS:- Copy the webhook URL provided on the connector detail page
- In the Butlr platform, navigate to the webhook or notification settings
- Add a new webhook endpoint using the KODE OS URL
- Configure the authentication header as specified on the connector detail page
- Save and enable the webhook
Configure Connector in KODE OS
- Navigate to Data Sources in your building
- Click API Catalog and search for Butlr
- Click + Add Datasource
- Complete the three-page setup flow using the credential prerequisites for this integration
Connector field metadata is not exposed in code for this integration. Configure the connector using your standard credentials and endpoint details shown in the prerequisites and vendor onboarding references.
Discover Devices and Points
After configuring the connector, click Discover on the connector detail page. KODE OS will query the Butlr system and return a list of available devices and their data points. Review the discovered items and select the devices you want to register in KODE OS. For more details on the discovery process, see the Discovery guide.Devices and Points
When you discover devices from Butlr, KODE OS maps them to the following device types and data points:Presence / Occupancy Sensor
Canonical Type:presenceDetection
What Data You Get
Point History
Time-series readings including count, status, in, out, collected at regular intervals from connected devicesEvent Logs
System and security event records with timestamps, event types, and associated devices KODE OS maps Butlr data to these standard fields:Polling Schedule
- Point History — Default polling: 5 minutes (min: 5 minutes, max: 1 hours)
- EventLog
Use Cases
Once connected, this integration enables you to:- Track real-time space utilization rates across floors and zones
- Optimize HVAC and lighting schedules based on actual occupancy patterns
- Generate utilization reports to inform space planning and real estate decisions
Troubleshooting
Authentication or connection error
Authentication or connection error
Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Double-check all credential fields match the values from the Butlr platform.
Webhook data not arriving
Webhook data not arriving
Verify the webhook URL is correctly registered in the Butlr platform. Check that the authentication header matches the value from the KODE OS connector detail page. Ensure the Butlr system can reach the KODE OS webhook endpoint over the network.
Discovery returns no devices
Discovery returns no devices
Verify the connector credentials have sufficient permissions in the Butlr system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
Data collection stops or gaps appear
Data collection stops or gaps appear
Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Butlr API.