Allgemeine Webhooks
- Andreas Bettenburg
- Mario Stelzer
aPAGER PRO ANDROID 5.5.0.77
Hintergrund
Mit den generischen Webhooks können beliebige HTTP Aufrufe durchgeführt werden. Zur Verfügung stehen die HTTP Verben GET und POST. Im Falle von GET stehen als Query Parameter das Stichwort und der Einheitenname zur Verfügung, im Falle von POST landen diese als JSON Objekt in einer UTF-8 kodierten Payload. Das genaue Format kann direkt bei der Konfiguration als Vorschau dargestellt werden.
Die Webhooks werden nur ausgelöst, wenn es sich um einen “echten” Alarm (Reiter “Alarm”) handelt. Info-, Wetter- oder Statusalarme werden nicht berücksichtigt!
Konfiguration in aPager PRO
Navigieren Sie zu Einstellungen → Labor
Wählen Sie einen beliebigen Webhook 1-5
Öffnen Sie die Konfigurationsansicht
Treffen Sie die notwendigen Einstellungen.
Eine tolle Seite zum Testen finden Sie unter Webhook.site - Test, transform and automate Web requests and emails
Natürlich benötigen Sie für den Produktivbetrieb die korrekte URL Ihres Anbieters.
Einheitenkennung und Stichwort können optional übertragen werden und werden im Alarmfall mit den aktuellen Werten überschrieben.
Nur zum Test wird “unit1” für die Einheitenkennung und “B3” für das Stichwort übertragen.
Als Query Parameter für die Einheitenkennung wird als Standard “unit” verwendet.
Als Query Parameter für das Stichwort wird als Standard “keyword” verwendet”
Beide Query Parameter lassen sich durch eigene Werte anpassen, welche über “Webhook Testen” jederzeit verifiziert werden können.
Auch die Vorschau passt sich dynamisch an Änderungen an.
Navigieren Sie über das Seitenmenü von aPager PRO zu “Klingeltöne”
Öffnen Sie die Einheitenkonfiguration für die Sie die generischen Webhooks aktivieren möchten.
Aktivieren Sie “Webhooks aktivieren” und wählen Sie den gewünschten, vorkonfigurierten Webhook aus, in unserem Beispiel die Nummer 1.
Vergessen Sie nicht die Einheitenkonfiguration zu speichern.
Fertig, ihr erster Webhook ist nun verknüpft. Testen Sie die Auslösung am besten gleich mit einem Testalarm an die konfigurierte Einheit direkt aus FE2.
Experteneinstellung: Platzhalter in URL verwenden
5.5.0.78
Es ist möglich Platzhalter innerhalb der URL zu verwenden, die zur Laufzeit durch die konkreten Werte ersetzt werden. Hierfür müssen die Schalter für Einheitenkennung / Stichwort übertragen aktiv sein.
Die unterstützten Parameter sind:
Parameter | Ersetzung durch |
|---|---|
{unit} | Einheitenkennung |
{keyword} | Stichwort |
Dadurch ergeben sich Möglichkeiten URLs wie die nachfolgende zu erstellen:
Eintrag in das Feld URL: https://mywebhookservice.com?cmd=set-{keyword}-on
Zur Laufzeit wird daraus: https://mywebhookservice.com?cmd=set-B3-on
Experteneinstellung: Eigenen Header übertragen
6.1.x
Es ist möglich eigene Header-Werte zu übertragen, z.B. um einen API-Key zu setzen.
Bitte aktivieren Sie “Eigenen Header-Wert übertragen” und tragen die gewünschten Daten ein. Testen Sie die eingestellten Werte bitte anschließend über “Webhook Testen”