Connect your first external system to KODE OS and start collecting dataThis guide walks you through connecting an external system to KODE OS, from finding the right integration to verifying data flow. The entire process takes a few minutes once you have your vendor credentials ready.
Before You Begin
Make sure you have the following before you start:
- KODE OS access — a user account with permission to manage data sources in the target building
- Vendor credentials — the API key, username/password, OAuth client ID/secret, or certificates required by the external system (check the specific integration page for what your vendor requires)
- Network connectivity — KODE OS must be able to reach the external system’s API endpoint (verify firewall rules and VPN access for on-prem systems)
1
Open Data Sources
Navigate to your building in KODE OS. In the left-side menu, click
Data Sources. This page displays any connectors you have already configured for this building.2
Find your integration
Click
API Catalog in the left menu. Browse integrations by system type (access control, metering, occupancy, lighting, and more) or use the search bar to find your vendor by name.Click on the integration to view its supported entities, collection schedules, and available data fields.3
Add a datasource
Click
+ Add Datasource at the top right of the integration detail page. A three-page setup flow opens.Page 1 — Credentials and settingsEnter the connection details for the external system. The required fields vary by integration but typically include:- URL — base URL or IP address of the external system
- Authentication — username/password, API key, OAuth credentials, or certificates
- Dynamic fields — some integrations show additional fields (such as Organization ID or Site ID) that populate automatically after your credentials are validated
Next once the fields are filled and validated.Page 2 — Entity enablementToggle which data entities you want to collect. Options vary by integration and may include Point History, Work Orders, Alarms, Audit Logs, or Schedule Sync. All available entities are enabled by default — disable any you do not need.Page 3 — Polling frequencySet how often KODE OS polls each enabled entity. Configure the time unit (seconds, minutes, hours, or days), the interval, and the start time. Each integration defines minimum and maximum polling intervals.Click Save to create the connector.4
Test the connection
On the connector detail page, click If the test fails, check that the URL is correct, credentials have not expired, and firewall rules allow outbound connections from KODE OS to the external system.
Test Connection. KODE OS authenticates with the external system using your credentials and verifies that the API endpoint is reachable.A successful test confirms the URL is reachable, credentials are valid, and the external system is responding correctly.
5
Run discovery
Click
Discover on the connector detail page. KODE OS queries the external system and returns a list of available devices, data points, schedules, and assets.Review the discovered items and select which ones to register in KODE OS. Selected items are saved and ready for data collection.Not all integrations support discovery. Webhook-only and MQTT integrations receive data as it arrives and do not require a discovery step.
6
Verify data flow
After the first polling interval passes, check the connector detail page:
- The collection chart shows data volume over time
- The current status indicator shows whether the connector is up
- Individual entity sections display collected records or time-series data
Cloud BMS to map ontology to your discovered devices for consistent naming across your building portfolio.What’s Next
Managing Connectors
Learn how to modify, monitor, and troubleshoot your connectors
Integrations Catalog
Browse all 200+ supported integrations by system category
Discovery
Understand how device, point, schedule, and asset discovery works
Data Collection
Learn about pull vs. push collection and snapshot, delta, and historical data types