> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/english-v14/apps/apps/roomz.md).

# ROOMZ

### Overview

This manual contains instructions for installing, configuring, and using the ROOMZ app for collecting data from ROOMZ sensors.

### Installation

Install the ROOMZ app from the Eliona App Store.

### Configuration

Register the app in ROOMZ and then configure the ROOMZ app via the Eliona settings.

#### Registering the app in the ROOMZ portal

The ROOMZ app uses an experimental [Webhook API](https://github.com/roomz-io/openapi), which is not yet generally available. Contact ROOMZ support to enable sending data and obtain a webhook secret. The webhook endpoint for your Eliona instance is: `https://{your-eliona-instance}/apps-public/roomz/webhook`.

> Since the webhook endpoint must be accessible over the internet, all incoming data is verified using the ROOMZ signature. For verification, ROOMZ must provide a webhook secret and a public key to verify the signature.

#### Configuration of the ROOMZ app

Configure the app in Eliona by going to `Apps > ROOMZ > Settings` navigating, which opens the [Generic Frontend](https://doc.eliona.io/collection/v/eliona-english/manuals/settings/apps) app page. Use the POST method to set up the configuration. Each configuration requires the following parameters:

| Attribute    | Description                                     |
| ------------ | ----------------------------------------------- |
| `secret`     | Webhook secret provided by ROOMZ.               |
| `enable`     | Flag to enable or disable this configuration.   |
| `projectIDs` | List of Eliona project IDs for data collection. |

Example configuration JSON:

```json
{
  "secret": "some-webhook-secret",
  "enable": true,
  "projectIDs": [
    "10"
  ]
}
```

### Continuous asset creation

After configuration, the app listens for data updates from ROOMZ. Every time the occupancy status changes (someone enters or leaves a room), the app receives a message from ROOMZ and writes the data to Eliona.

The app automatically creates all assets for the monitored rooms - When the app receives data from a sensor for the first time, it creates a new asset under the "ROOMZ root" asset. The asset is named after the room ID (the only information provided by the ROOMZ API), but can be renamed and moved by the user.

The user who created or last updated the app configuration is notified about newly created assets.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.buildings.ability.abb/collection/english-v14/apps/apps/roomz.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.