Connect Webex API to KODE OS for occupancy, indoor environmental quality data integration
Overview
Use this integration to connect Webex workspace devices to KODE OS. You can discover room and sensor assets, collect snapshot occupancy plus air quality, temperature, and sound readings on a schedule, and use webhooks or hybrid collection where your deployment supports it.Supported Capabilities
- Discover Devices & Points
- Collect Sensor Data
- Receive Webhook Data
- File Validation
Prerequisites
- An active account with Webex API and access to their API or developer portal
- OAuth client credentials (Client ID and Client Secret) from the Webex API developer portal
- KODE OS environment with access to Data Sources
Generate API Credentials
- Log in to the Webex API developer portal or admin console
- Navigate to the API or developer settings section
- Create a new API application or client
- Note the Client ID and Client Secret — you will need these when configuring the connector in KODE OS
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 Webex API 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 Webex API
- Click + Add Datasource
- Fill in the fields below and complete the three-page setup flow
Discover Devices and Points
After configuring the connector, click Discover on the connector detail page. KODE OS will query the Webex API 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 Webex API, KODE OS maps them to the following device types and data points:Air Quality Sensor
Canonical Type:airQuality
What Data You Get
Point History
Time-series readings including temperature, soundLevel, ambientNoise, humidity, peopleCount, occupied, airQuality, standbyState, and 1 more, collected at regular intervals from connected devicesPolling Schedule
- Point History — Default polling: 15 minutes (min: 15 minutes, max: 1 hours)
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
- Monitor air quality metrics (CO2, VOC, humidity, temperature) across all occupied spaces
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. Ensure the Client ID and Client Secret match the values from the Webex developer portal.
Webhook data not arriving
Webhook data not arriving
Verify the webhook URL is correctly registered in the Webex platform. Check that the authentication header matches the value from the KODE OS connector detail page. Ensure the Webex 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 Webex 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 Webex API.