> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Willow API

> Connect Willow API to KODE OS for controller data

> Connect Willow API to KODE OS for controller data integration

## Overview

Use this integration to connect the Willow API to KODE OS. You can discover base-building BMS equipment and points, collect sensor readings through push delivery, and validate ingested files as part of your data pipeline.

| Property            | Value      |
| ------------------- | ---------- |
| **System Type**     | Controller |
| **Communication**   | REST       |
| **Collection**      | Push       |
| **Collection Mode** | HISTORICAL |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* File Validation

## Prerequisites

* An active account with Willow API and access to their API or developer portal
* OAuth client credentials (Client ID and Client Secret) from the Willow API developer portal
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Willow API developer portal or admin console
2. Navigate to the API or developer settings section
3. Create a new API application or client
4. Note the **Client ID** and **Client Secret** -- you will need these when configuring the connector in KODE OS

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Willow API**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field             | Required | Type     | Description                                                               |
| ----------------- | -------- | -------- | ------------------------------------------------------------------------- |
| **URL**           | Yes      | text     | The base URL or IP address of the external system                         |
| **Client ID**     | Yes      | text     | The OAuth client ID from the vendor's developer portal                    |
| **Client Secret** | Yes      | password | The OAuth client secret from the vendor's developer portal                |
| **File**          | Yes      | file     | An upload file used during discovery (e.g., device whitelist spreadsheet) |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Willow 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](/products/integrations/capabilities/discovery).

## What Data You Get

### Point History

Time-series sensor readings such as temperature, humidity, CO2, occupancy counts, energy consumption, light levels, and other measurable values from physical sensors

### Polling Schedule

* **Point History** -- Default polling: 5 minutes (min: 5 minutes, max: 1 hours)

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Use Cases

Once connected, this integration enables you to:

* Monitor real-time HVAC, lighting, and building automation data from a single dashboard
* Set up automated alerts when equipment deviates from normal operating parameters
* Track energy consumption and optimize building performance with historical trend data

## Troubleshooting

<AccordionGroup>
  <Accordion title="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 Willow developer portal.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Willow system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="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 Willow API.
  </Accordion>
</AccordionGroup>