> For the complete documentation index, see [llms.txt](https://docs.enginsight.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enginsight.com/docs/manual/bedienung-der-plattform/alarme/management/webhooks.md).

# Webhooks

Webhooks bieten dir die Möglichkeit, Alarme mit Drittanbieter-Anwendungen zu verknüpfen, um bspw. Benachrichtigungen auch außerhalb der Enginsight Plattform erhalten zu können.

***

<i class="fa-compass">:compass:</i> Navigiere zu **Alarme** → **Webhooks**, um eine Auflistung aller angelegten Webhooks anzuzeigen. Wenn du noch keinen Webhook erstellt hast, ist diese Ansicht leer.

<figure><img src="https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2F0yyq1t7L0z8qLB08tYDE%2Fenginsight-screenshot-alarme-webhooks.jpg?alt=media&amp;token=e7bd688b-ae09-4597-9840-20aebab4eedd" alt=""><figcaption></figcaption></figure>

Du kannst der [Webhook-Übersicht](#webhook-ubersicht) unter anderem entnehmen:

* welche HTTP-Methode von einem Webhook verwendet wird.
* welche Ziel-URL für den Webhook hinterlegt wurde.

Des Weiteren hast du hier die Möglichkeit, [Webhooks zu exportieren](#webhooks-exportieren) sowie neue [Webhooks zu erstellen](#webhook-hinzufugen).

***

## Navigation&#x20;

<i class="fa-magnifying-glass">:magnifying-glass:</i> Klicke in das Feld **Freitextsuche** oberhalb der Liste und gib einen frei gewählten Suchbegriff ein, um bestimmte Listenelemente zu finden.

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf das **Aktualisieren**-Symbol <i class="fa-arrows-rotate-reverse">:arrows-rotate-reverse:</i> oberhalb der Liste, um alle Listenelemente zu aktualisieren.

<i class="fa-computer-mouse-scrollwheel">:computer-mouse-scrollwheel:</i> Scrolle in der Liste nach unten oder passe die Ergebnisanzeige pro Seite an: ![](https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2F4dt8uCIVEfVsPI3AoZue%2FEnginsight-Seitennavigation.jpg?alt=media\&token=87f0c892-fd95-4690-93ca-f6864726c0e3) um weitere Einträge in der Liste zu sehen.\
Nutze die Seitennavigation: ![](https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2FwV6Kk3IY4G4vLV2B2Xao%2FEnginsight-Seitennavigation-2.jpg?alt=media\&token=084a8396-572f-40af-a5a4-c96f6ae91d72) um zwischen mehreren Seiten zu wechseln.

### Listenelemente sortieren

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke im Tabellenkopf auf das **Sortieren**-Symbol <i class="fa-sort">:sort:</i> neben einem Spaltennamen, um nach der jeweiligen Spalte in aufsteigender Reihenfolge <i class="fa-angle-up">:angle-up:</i> oder in absteigender Reihenfolge <i class="fa-chevron-down">:chevron-down:</i> zu sortieren.

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf das **Sortieren**-Symbol <i class="fa-bars-sort">:bars-sort:</i> oberhalb der Liste, um die Priorität der vorgenommenen Sortierung anzupassen. Es öffnet sich ein Menü, in dem alle Spalten angezeigt werden, nach denen die Liste sortiert ist. Verschiebe die angezeigten Elemente per Drag-and-Drop, um die Sortierpriorität zu ändern.

### Weitere Aktionen für Listenelemente

<i class="fa-computer-mouse">:computer-mouse:</i> Setze einen Haken in die Checkbox <i class="fa-square">:square:</i> neben einem Listenelement, um das entsprechende Element auszuwählen. Oder setze einen Haken in die Checkbox im Tabellenkopf, um alle Listenelemente gemeinsam auszuwählen.

Neben dem Suchfeld erscheint nun die Anzahl der ausgewählten Listenelemente.

Zudem erscheint das Menü <i class="fa-slider">:slider:</i> **Aktionen** in der rechten oberen Ecke. Klicke darauf, um das dazugehörige Untermenü auszuklappen. Folgende Aktionen stehen zur Verfügung:

<table><thead><tr><th width="149.84375">Aktion</th><th>Beschreibung</th></tr></thead><tbody><tr><td>Auswahl exportieren</td><td><p>Exportiere alle ausgewählten Objekte.</p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <strong>Auswahl exportieren</strong>, um ein neues Fenster zu öffnen, in dem du weitere <a href="#webhooks-exportieren">Einstellungen für den Export</a> vornehmen kannst.</p></td></tr><tr><td>Löschen</td><td><p>Lösche alle ausgewählten Objekte.<br></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <strong>Löschen</strong> und bestätige die Meldung, die erscheint, mit Klick auf <strong>Unwiederbringlich Löschen</strong>.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Bitte beachte</strong>: Gelöschte Elemente können nicht wiederhergestellt werden.</p></div></td></tr></tbody></table>

***

## Webhook: Übersicht

Die Webhook-Übersicht ist als tabellarische Liste aufgebaut.

<figure><img src="https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2FzwAg3IxILHijdYMBDNs4%2Fenginsight-screenshot-alarme-webhooks-u%CC%88bersicht.jpg?alt=media&amp;token=283798c1-8b3c-4b44-9ded-4907ff51a979" alt=""><figcaption></figcaption></figure>

Du kannst der Liste folgende Informationen entnehmen:

<table><thead><tr><th width="199.98046875">Spalte</th><th>Beschreibung</th></tr></thead><tbody><tr><td>Name</td><td><p>Zeigt den benutzerdefinierten Namen des Webhooks.</p><p></p><p>Zudem werden Erstelldatum und -uhrzeit sowie letztes Bearbeitungsdatum und -uhrzeit angezeigt.</p><p><br><i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf den Namen eines Webhooks, um zur entsprechenden <a href="#webhook-bearbeitungsansicht">Bearbeitungsansicht</a> zu navigieren. Hier kannst du vorgenommene Einstellungen anpassen und den Webhook löschen.</p></td></tr><tr><td>Methode </td><td><p>Zeigt die für den Webhook gewählte HTTP-Methode.</p><p></p><p>Folgende Methoden können angezeigt werden:</p><ul><li><strong>GET</strong>: Der Webhook ruft Daten vom Zielsystem ab.</li><li><strong>POST</strong>: Der Webhook erstellt neue Daten im Zielsystem oder übermittelt Daten an das Zielsystem.</li><li><strong>PATCH</strong>: Der Webhook aktualisiert bestehende Daten im Zielsystem teilweise.</li><li><strong>PUT</strong>: Der Webhook aktualisiert bestehende Daten im Zielsystem vollständig.</li><li><strong>DELETE</strong>: Der Webhook löscht bestehende Daten im Zielsystem.</li></ul></td></tr><tr><td>Ziel</td><td>Zeigt die Ziel-URL, an die die Webhook-Anfrage gesendet wird.</td></tr><tr><td>Content-Typ</td><td>Zeigt das Format des Inhalts der Webhook-Anfrage.</td></tr></tbody></table>

***

## Webhook hinzufügen

Du hast zwei Möglichkeiten, einen Webhook hinzuzufügen. Zum Einen kannst du neue Webhooks erstellen. Zum Anderen hast du die Möglichkeit, Webhooks, die du zuvor bspw. aus anderen Organisationen exportiert hast, zu importieren.

### Option 1: Neuen Webhook erstellen

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <i class="fa-plus">:plus:</i> **Webhook hinzufügen** in der rechten oberen Ecke und wähle aus dem Untermenü, das sich öffnet, die Option <i class="fa-plus">:plus:</i> **Neu anlegen** aus, um einen [neuen Webhook zu erstellen](https://docs.enginsight.com/docs/manual/bedienung-der-plattform/alarme/management/webhooks/webhook-hinzufugen.md).

### Option 2: Webhooks importieren

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <i class="fa-plus">:plus:</i> **Webhook hinzufügen** in der rechten oberen Ecke und wähle aus dem Untermenü, das sich öffnet, die Option <i class="fa-up-from-line">:up-from-line:</i> **Importieren** aus, um einen oder mehrere [Webhooks zu importieren](https://docs.enginsight.com/docs/manual/bedienung-der-plattform/alarme/management/webhooks/webhook-hinzufugen.md#webhooks-importieren).

***

## Webhooks exportieren

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <i class="fa-down-to-line">:down-to-line:</i> **Webhooks exportieren** in der rechten oberen Ecke, um ein neues Fenster zu öffnen, in dem du weitere Einstellungen für den Export vornehmen kannst.

<div align="left"><figure><img src="https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2FbKfndeT3dFUpdiiSeLTV%2FEnginsight-Alarme-Webhooks%20exportieren.jpg?alt=media&amp;token=f60b4e70-8fd8-496d-81e9-d50814723c88" alt=""><figcaption></figcaption></figure></div>

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf **Alles exportieren**, um alle Webhooks oder nur die [ausgewählten Webhooks](#zugeordnete-referenzen) herunterzuladen. Der Export erfolgt im ZIP-Format.

{% hint style="info" %}
Die exportierte Datei findest du im standardmäßig von deinem Browser genutzten Speicherort.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf **Abbrechen**, um zur Listenübersicht zurückzukehren.

### Zugeordnete Referenzen

Hier kannst du spezifische Webhooks festlegen, die exportiert werden sollen.

{% hint style="info" %}
Die Angabe von zugeordneten Referenzen ist optional.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke dazu in das Feld **Webhooks**, um eine Liste aller verfügbaren Webhooks auszuklappen, und wähle einen oder mehrere Webhooks aus, die exportiert werden sollen.

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf das **Entfernen**-Symbol <i class="fa-xmark">:xmark:</i> neben einem hinzugefügten Webhook, um ihn wieder aus dem Feld **Webhooks** zu entfernen.

#### Ausgeschlossene Referenzen

Hier kannst du spezifische Benachrichtigungsvorlagen festlegen, die vom Export ausgeschlossen werden sollen.

{% hint style="info" %}
Die Angabe von ausgeschlossenen Referenzen ist optional.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <i class="fa-plus">:plus:</i> **Ausnahmen definieren** neben **Zugeordnete Referenzen**, um die Optionen für ausgeschlossene Referenzen anzuzeigen.

<i class="fa-gear">:gear:</i> Nimm alle Einstellungen wie bei der Angabe einer [zugeordneten Referenz](#zugeordnete-referenzen) vor.

***

## Webhook: Bearbeitungsansicht

<i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf den Namen eines Webhooks, um zur entsprechenden Bearbeitungsansicht zu navigieren. Hier kannst du [vorgenommene Einstellungen](https://docs.enginsight.com/docs/manual/bedienung-der-plattform/alarme/management/webhooks/webhook-hinzufugen.md#grundeinstellungen) anpassen und den Webhook löschen.

<figure><img src="https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2FnOeSXODfHuRGoWY2QGLu%2Fenginsight-alarme-management-webhooks-benachrichtigungsvorlagen-bearbeitungsansicht.jpg?alt=media&amp;token=e68d973f-aa21-436e-926e-fb16bfd2125c" alt=""><figcaption></figcaption></figure>

Folgende Aktionen stehen zur Verfügung:

<table><thead><tr><th width="200.39453125">Option</th><th>Beschreibung</th></tr></thead><tbody><tr><td>Änderungen speichern</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <strong>Änderungen speichern</strong>, nachdem du Einstellungen geändert hast.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Bitte beachte</strong>: Nicht gespeicherte Änderungen können nicht wiederhergestellt werden!</p></div></td></tr><tr><td>Zurück</td><td><i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <strong>Zurück</strong>, um zurück zur Listenübersicht zu gelangen.</td></tr><tr><td>Löschen</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Klicke auf <strong>Löschen</strong> und bestätige die Meldung, die erscheint, um das Objekt, das du gerade bearbeitest, zu löschen.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Bitte beachte</strong>: Gelöschte Objekte können nicht wiederhergestellt werden!</p></div></td></tr></tbody></table>

### Aufrufe der Webhook-URL

Sobald eine Webhook-URL aufgerufen wurde, findest du auf der rechten Seite der Bearbeitungsansicht eine Liste aller Aufrufe.

<div align="left"><figure><img src="https://1720942473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1oAJCT6yz8fThAzdCQJt%2Fuploads%2FN3N4VNopuMEhxAJUgZ5q%2FEnginsight-Alarme-Webhook%20hinzufuegen-Webhook%20Aufrufe.jpg?alt=media&amp;token=c8ccf39d-3b57-49b1-97c9-c6e45f299c45" alt=""><figcaption></figcaption></figure></div>

Du kannst der Liste folgende Informationen entnehmen:

<table><thead><tr><th width="199.98046875">Spalte</th><th>Beschreibung</th></tr></thead><tbody><tr><td>Status</td><td>Zeigt den HTTP-Status, der als Antwort auf die gesendete HTTP-Anfrage zurückgegeben wurde.</td></tr><tr><td>Methode </td><td>Zeigt die für den Webhook gewählte HTTP-Methode.</td></tr><tr><td>Ziel</td><td>Zeigt die Ziel-URL, an die die Webhook-Anfrage gesendet wurde.</td></tr><tr><td>Erstellt am</td><td>Zeigt das Datum und die Uhrzeit, wann die Webhook-URL aufgerufen wurde.</td></tr></tbody></table>

***
