> 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/platform/live-cockpit/widgets/custom-widgets/modules/alarm.md).

# Alarm

The *Alarm Widget* in BuildingPro Suites makes it possible to display and manage alarms for a specific asset or a list of alarms. This can be used for both individual assets and for an overview of all alarms.

<figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2FaltrkPecyuNaEpulzS91%2FAlarm%20modul.png?alt=media&#x26;token=0782b76d-3ebb-45a5-96eb-c8f828e95d8a" alt=""><figcaption></figcaption></figure>

<table data-full-width="true"><thead><tr><th width="61"></th><th width="120.79998779296875"></th><th></th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Description</td><td>This text is displayed when the custom widget is later connected to assets</td></tr><tr><td><strong>[B]</strong></td><td>Variant</td><td><p>This option is only available when "Total number of alarms" is selected for <strong>Alarm Type [C]</strong></p><ul><li>Large: Shows how many total tickets are present</li><li>Small: Only shows tickets sorted by categories.</li></ul></td></tr><tr><td><strong>[C]</strong></td><td>Alarm Type</td><td><ul><li><strong>Total number of alarms:</strong> Shows all present alarms sorted by priority. <a href="https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/predefined-widgets/alarm-overview.md">-> to the widget</a></li><li><strong>Alarm for asset:</strong> Shows all alarms for a single asset. <a href="https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/custom-widgets/modules/alarm.md">-> to the widget</a></li><li><strong>List of alarms:</strong> Shows all alarms in a scrollable list. <a href="https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/custom-widgets/list-of-alarms.md">-> to the widget</a></li><li><strong>Detailed list of alarms:</strong> Shows the alarms in detailed form. <a href="https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/custom-widgets/detailed-list-of-alarms.md">-> to the widget</a></li></ul></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/custom-widgets/modules/alarm.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
