> ## 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.

# Webex API

> Connect Webex API to KODE OS for occupancy, indoor environmental quality data

> 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.

| Property            | Value                                   |
| ------------------- | --------------------------------------- |
| **System Type**     | Occupancy, Indoor Environmental Quality |
| **Communication**   | REST + Webhook                          |
| **Collection**      | Hybrid (Pull + Push)                    |
| **Collection Mode** | SNAPSHOT                                |

## 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

1. Log in to the Webex 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 Webhook

This integration uses webhooks for real-time data delivery. After creating the connector in KODE OS:

1. Copy the webhook URL provided on the connector detail page
2. In the Webex API platform, navigate to the webhook or notification settings
3. Add a new webhook endpoint using the KODE OS URL
4. Configure the authentication header as specified on the connector detail page
5. Save and enable the webhook

## Configure Connector in KODE OS

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

| Field                | Required    | Type     | Description                                                               |
| -------------------- | ----------- | -------- | ------------------------------------------------------------------------- |
| **URL**              | Conditional | text     | The base URL or IP address of the external system                         |
| **Client ID**        | Conditional | password | The OAuth client ID from the vendor's developer portal                    |
| **Client Secret**    | Conditional | password | The OAuth client secret from the vendor's developer portal                |
| **User Key**         | Conditional | password | The user-specific key from the vendor platform                            |
| **Redirect URI**     | Conditional | text     | The OAuth redirect URI configured in the vendor portal                    |
| **API Building ID**  | Yes         | text     | The building or source identifier in the external system                  |
| **Temperature Unit** | No          | dropdown | The preferred temperature unit                                            |
| **File**             | Conditional | 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 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](/products/integrations/capabilities/discovery).

## 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`

| # | Point              | Description                                                              | Unit     | Writable | Ontology Field                       | Collection |
| - | ------------------ | ------------------------------------------------------------------------ | -------- | -------- | ------------------------------------ | ---------- |
| 1 | `temperature`      | Current temperature reading                                              | --       | No       | `zone_air_temperature_sensor`        | Webhook    |
| 2 | `soundLevel`       | Ambient sound level (dB)                                                 | decibels | No       | --                                   | Webhook    |
| 3 | `ambientNoise`     | Ambient sound level (dB)                                                 | decibels | No       | `noise_sensor`                       | Webhook    |
| 4 | `humidity`         | Relative humidity level (%RH)                                            | %RH      | No       | `zone_air_humidity_sensor`           | Webhook    |
| 5 | `peopleCount`      | Number of people currently detected in the space                         | --       | No       | `occupancy_count`                    | Webhook    |
| 6 | `occupied`         | **Yes** -- space is currently occupied / **No** -- space is not occupied | --       | No       | `occupancy_status`                   | Webhook    |
| 7 | `airQuality`       | Composite air quality index                                              | --       | No       | `voc_concentration_detection_sensor` | Webhook    |
| 8 | `standbyState`     | Device connectivity status                                               | --       | No       | `connection_status`                  | Webhook    |
| 9 | `connectionStatus` | Device connectivity status                                               | --       | No       | --                                   | Webhook    |

## 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 devices

### Polling Schedule

* **Point History** -- Default polling: 15 minutes (min: 15 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:

* 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

<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 Webex developer portal.
  </Accordion>

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

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