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

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

Create a New Endpoint/Adjust an Existing Endpoint

Fig. 3 – The "Configure Endpoint" menu

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

9. Click on [T] to save the settings.