> 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/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-webhook.md).

# Connect Devices via Webhook

## Procedure

With a connection via webhook, BuildingPro Suites functions as a server. A client, e.g., a gateway to which devices are connected, transmits information to BuildingPro Suites via HTTP.

For this purpose, an endpoint is created in BuildingPro Suites. The client sends data to this endpoint.

## Overview

<figure><img src="/files/SFUZsMemRaX2R0NiL9JY" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/dggF6rqp9enM01fjZVeq" alt=""><figcaption></figcaption></figure>

<table data-full-width="true"><thead><tr><th width="67.53331502278644">Symbol</th><th width="183.20001220703125">Description</th><th>Details</th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Menu "Connections"</td><td>Click to open the "Connections" menu</td></tr><tr><td><strong>[B]</strong></td><td>Tab</td><td>Access to the respective interfaces</td></tr><tr><td><strong>[C]</strong></td><td>Workspace</td><td>Shows a list of the existing endpoints (if any)</td></tr><tr><td><strong>[D]</strong></td><td>Endpoint</td><td>Existing endpoints</td></tr><tr><td><strong>[E]</strong></td><td>Pause/resume connection</td><td>Click to pause or resume a connection</td></tr><tr><td><strong>[F]</strong></td><td>Connection status</td><td>Shows the current status of the connection</td></tr><tr><td><strong>[G]</strong></td><td>Name</td><td>Name of the endpoint</td></tr><tr><td><strong>[H]</strong></td><td>Path</td><td>The path to which the information is sent</td></tr><tr><td><strong>[I]</strong></td><td>Protection</td><td>Shows the protection status of the respective endpoint</td></tr><tr><td><strong>[J]</strong></td><td>Format</td><td>Shows the format that is applied to the selected data</td></tr><tr><td><strong>[K]</strong></td><td>Copy</td><td>Click to duplicate the endpoint</td></tr><tr><td><strong>[L]</strong></td><td>Add new endpoint</td><td>Click to add a new endpoint. Opens the ↗Endpoint Details</td></tr><tr><td><strong>[M]</strong></td><td>Delete endpoint</td><td>Deletes the respective endpoint. ⚠ Caution: If the connection is also used in other tenants, it will also be deleted there.</td></tr><tr><td><strong>[N]</strong></td><td>Endpoint details</td><td>Click to edit the details of the respective endpoint.</td></tr></tbody></table>

## Create a New Endpoint/Adjust an Existing Endpoint

<figure><img src="/files/Nx38IDbxm1lowtdnnuRX" alt=""><figcaption><p>Fig. 3 – The "Configure Endpoint" menu</p></figcaption></figure>

1. Click on **Connections \[A]**

   ▷ The Connections window opens
2. Click on **Webhook \[B]**
3. Click on **\[L]** to create a new endpoint **⇄ OR** Click on **\[N]** to edit an existing endpoint.

   ▷ The "Configure Endpoint" menu opens.
4. In **\[O]**, give the endpoint a name. The endpoint is displayed under this name in **\[G]**.
5. In **\[P]**, enter a path. The client will send information to this path. ♢ The path consists of 2 parts: a non-editable base URL and a part that you can change.
6. Optional: In **\[Q]**, enter an Authorization Key. If you enter a value here, the corresponding value must be sent by the client in the request. Otherwise, the request is not accepted. If you do not want to assign an Authorization Key: Leave the field empty.
7. In **\[R]**, select the format that is applied to the incoming data.
8. Optional: Click on **\[S]** to [↗ create a new format](/collection/mandatory-base/platform-core/connect-hub/data-processing-function-formats/configure-a-format.md#create-a-format)
9. Click on **\[T]** to save the settings.


---

# 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/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-webhook.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.