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

# Kone

> Connect Kone to KODE OS for elevator system data

> Connect Kone to KODE OS for elevator system data integration

## Overview

Use this integration to connect KONE elevator and people-flow data to KODE OS. REST and webhooks deliver real-time lift status, events, and operational metrics for your connected assets.

| Property            | Value           |
| ------------------- | --------------- |
| **System Type**     | Elevator System |
| **Communication**   | REST + Webhook  |
| **Collection**      | Pull            |
| **Collection Mode** | SNAPSHOT        |

## Supported Capabilities

* Collect Sensor Data
* Receive Webhook Data

## Prerequisites

* An active account with Kone and access to their API or developer portal
* API key or token from the Kone platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Kone 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 Kone 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 **Kone**
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 |
| **API Key**       | Yes      | password | The API key for authenticating with the external system    |

## Devices and Points

| Point                                | Display Name                       |
| ------------------------------------ | ---------------------------------- |
| `com.kone.equipment.availability.v1` | com kone equipment availability v1 |
| `com.kone.equipment.status.v1`       | com kone equipment status v1       |
| `Equipment ID`                       | Equipment ID                       |

## What Data You Get

### Movement Data

Movement tracking and people flow data including direction, count, and location

### Audit Logs

Access and security event records including badge swipes, door access events, person identification, timestamps, and access results

KODE OS maps the collected data to these standard fields:

| KODE Field          | Description                                     |
| ------------------- | ----------------------------------------------- |
| **ID**              | Unique log entry identifier                     |
| **Description**     | Event description                               |
| **Person Name**     | Name of the person involved                     |
| **Credential ID**   | Badge or credential identifier used             |
| **Credential Type** | Type of credential (e.g., Card, PIN, Biometric) |
| **Role**            | Access role or clearance level                  |
| **Type**            | Event type (e.g., Entry, Exit, Denied)          |
| **Result**          | Access result (Granted, Denied, Error)          |
| **Access Point**    | Door or access point name                       |
| **Location**        | Physical location of the access point           |
| **Access Time**     | Timestamp of the access event                   |
| **Created At**      | Timestamp when the log was recorded             |

### Polling Schedule

* **Movement**
* **Audit Log**

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 elevator call counts, wait times, and operational status
* Track elevator service intervals and maintenance needs
* Correlate elevator usage patterns with building occupancy 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 Kone developer portal.
  </Accordion>

  <Accordion title="Webhook data not arriving">
    Verify the webhook URL is correctly registered in the Kone platform. Check that the authentication header matches the value from the KODE OS connector detail page. Ensure the Kone system can reach the KODE OS webhook endpoint over the network.
  </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 Kone API.
  </Accordion>
</AccordionGroup>