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

# Impak

> Connect Impak to KODE OS for work orders data

> Connect Impak to KODE OS for work orders data integration

## Overview

Use this integration to connect Impak to KODE OS. You can collect sensor and non-sensor work order data over REST with hybrid snapshot collection and use supported connector actions from Data Sources.

| Property            | Value                |
| ------------------- | -------------------- |
| **System Type**     | Work Orders          |
| **Communication**   | REST                 |
| **Collection**      | Hybrid (Pull + Push) |
| **Collection Mode** | SNAPSHOT             |
| **Actions**         | Supported            |

## Supported Capabilities

* Collect Sensor Data
* Collect Non-Sensor Data

## Prerequisites

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

## Generate API Credentials

1. Log in to the Impak platform or admin console
2. Navigate to the API settings, developer section, or account settings
3. Generate a new API key or token
4. Copy the key and store it securely -- you will need it 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 **Impak**
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        |
| **API Key**  | Yes      | password | The API key for authenticating with the external system  |
| **Username** | Yes      | text     | The username for authenticating with the external system |
| **Password** | Yes      | password | The password for authenticating with the external system |

## Devices and Points

| Point                   | Display Name          |
| ----------------------- | --------------------- |
| `getSensorList`         | getSensorList         |
| `getWorkOrderSensor`    | getWorkOrderSensor    |
| `createWorkOrderSensor` | createWorkOrderSensor |
| `APM`                   | APM                   |

## What Data You Get

### Work Orders

Maintenance and service requests including title, description, status, priority, assignee, due dates, vendor response, resolution details, and cost estimates

KODE OS maps Impak data to these standard fields:

| KODE Field            | Source Field                                                                                    | Notes                |
| --------------------- | ----------------------------------------------------------------------------------------------- | -------------------- |
| **id**                | `workOrderId`                                                                                   | --                   |
| **description**       | `request`                                                                                       | --                   |
| **status**            | `wOStatus`                                                                                      | --                   |
| **priority**          | `priority`                                                                                      | --                   |
| **category**          | `jobType`                                                                                       | --                   |
| **location**          | `serviceLocation`                                                                               | --                   |
| **createdBy**         | `requestor`                                                                                     | --                   |
| **assignmentGroup**   | `technicians`                                                                                   | --                   |
| **createdAt**         | `ImpakUtils.convertBuildingTzDateTimeToUtcMillis( requestDate, notBlank(requestTime`            | --                   |
| **dueDate**           | `ImpakUtils.convertBuildingTzDateTimeToUtcMillis( dueDate, END_OF_DAY_TIME, buildingTz, false`  | --                   |
| **startedAt**         | `ImpakUtils.convertBuildingTzDateTimeToUtcMillis(startDate, startTime, buildingTz, true`        | --                   |
| **completedAt**       | `ImpakUtils.convertBuildingTzDateTimeToUtcMillis( completeDate, completeTime, buildingTz, true` | --                   |
| **estimatedCost**     | `billable`                                                                                      | --                   |
| **serviceProvider**   | `contractor`                                                                                    | --                   |
| **resolutionDetails** | `technicianNotes`                                                                               | --                   |
| **assetId**           | `equipmentId`                                                                                   | --                   |
| **assetName**         | `equipment`                                                                                     | --                   |
| **customFields**      | `(custom fields)`                                                                               | custom fields object |

### Polling Schedule

* **WorkOrder** -- Default polling: 30 minutes (min: 30 minutes, max: 1 hours)

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

## Available Actions

### Create Work Order

**Type:** Write

Creates a new work order in Impak

| Field                 | Type   | Required | Input    | Options / Default |
| --------------------- | ------ | -------- | -------- | ----------------- |
| **Sensor Identifier** | STRING | Yes      | Text Box | --                |
| **Work Order Detail** | STRING | No       | Text Box | --                |

#### Example Request

```json theme={null}
{
  "sensorIdentifier": "12345",
  "workOrderDetail": "example-value"
}
```

#### Expected Result

* KODE OS sends the action to the external API using the configured connector credentials
* The external system returns success (typically HTTP 2xx) and processes the requested operation

For more details on how actions work, see the [Actions guide](/products/integrations/capabilities/actions).

## Use Cases

Once connected, this integration enables you to:

* Centralize maintenance requests and work order status from facility management systems
* Create and update work orders directly from KODE OS when issues are detected
* Track maintenance KPIs including response time, completion rate, and cost

## 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 API key or token is valid and has not been revoked or expired in the Impak platform.
  </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 Impak API.
  </Accordion>
</AccordionGroup>