Wie können wir helfen?

Heimautomatisierung mit Webhooks

Du bist hier:
< Alle Themen

Allgemeines

Webhooks sind ein automatisches Verfahren um Servern mitzuteilen, dass ein bestimmtes Ereignis eingetreten ist. Hierzu wird eine URL ähnlich wie eine Webseite automatisch aufgerufen. Dabei können innerhalb der URL verschiedene Parameter übergeben werden.

Benutzer / Standortebene

Feuer Software Connect stellt Webhooks auf Benutzer und Standortebene bereit.

Webhooks auf Benutzerebene können von jedem Benutzer selbst eingerichtet werden und dienen beispielsweise dazu, Smart Home Geräte anzusteuern. Diese Webhooks unterstützen nur die Überhabe des Alarmstichworts, nicht der Adresse oder Zusatzinformationen.

Webhooks auf Standortebene können nur von einem Standortadministrator angelegt werden und dienen beispielsweise dazu, das Tor der Fahrzeughalle zu öffnen, das Licht einzuschalten oder eine Info auf der Homepage zu veröffentlichen. Bei Webhooks auf Standortebene können zusätzlich auch die Adresse des Einsatzortes, sowie der Sachverhalt und die Connect Einsatz ID übergeben werden. Außerdem kann man den Webhook auch bei weiteren Event wie Einsatz beendet auslösen.


Einrichtung Benutzer Webhook

In Connect können bei Alarmierung eines Benutzers ein automatischer Webhook ausgelöst werden. Hierüber können beispielsweise externe Systeme wie Smart Home Lösungen angesteuert werden. Beispielsweise kann bei Alarmeingang eine Lampe zuhause eingeschaltet werden.

Um einen Webhook anzulegen, melden Sie sich im Connect Portal an und wählen den Menüpunkt „Smart Home“ und „Benutzer Webhook“ aus. Legen Sie nun einen neuen Eintrag an. Wählen Sie aus, wann der Webhook ausgelöst werden soll und tragen Sie die entsprechende URL ein. Die URL des Servers, welches sie ansteuern müssen ist individuell und hängt von der eingesetzten Lösung ab.

Wichtig: Die URL muss aus dem Internet erreichbar sein!

WebHook-URLs um Variablen ergänzen

Ergänzend können die URLs um folgende Platzhalter ergänzt werden, die beim Senden durch die entsprechenden Einsatzinformationen ergänzt werden:

  • {Kategorie} – Die Einsatzkategorie.
  • {Standort} – Der Connect-Standort, der den Einsatz empfangen hat. Für Personen, die Mitglied in mehreren Standorten sind.
  • {Stichwort} – Einsatzstichwort
  • {Stichwortübersetzung} – Einsatzstichwort nach Übersetzung
  • {Fahrzeuge} – Alarmierte Fahrzeuge
  • {Alarmgruppen} – Alarmgruppen
  • {Infogruppen} – Alarmgruppen welche informiert werden

Beispielsweise könnte man so das oben angelegte Einsatzlicht anhand der Kategorie in verschiedenen Farben leuchten lassen.

Weitere Variablen sind aus Datenschutzgründen nicht erlaubt und daher technisch unterbunden.

Praxisbeispiel: Einsatzlicht mit Philips Hue und IFTTT

Im Folgenden wird beschrieben wie eine Philips Hue Leuchte mittels IFTTT bei einem Einsatz angeschaltet werden kann:

  1. Zur Vorbereitung muss für deine Hue Bridge der Fernzugang aktiviert werden.
  2. Für die Verbindung zwischen Connect und deiner Philips Hue Leuchte wird ein Account bei IFTTT (oder einem anderen Anbieter) benötigt.
  3. Unter https://ifttt.com/create auf „+this“ klicken, um ein neues Applet anzulegen.
  4. Im ersten Schritt unter Services „Webhook“ wählen.
  5. Im zweiten Schritt „Receive a web request“ wählen.
  6. Als Event „Einsatz“ eintragen und mit „Create Trigger“ bestätigen.
  7. Anschließend auf „+that“ klicken.
  8. Als Action Service „Philips Hue“ auswählen. Hier muss bei der ersten Verwendung die Verbindung zu Philips Hue hergestellt werden.
  9. Im vierten Schritt die Aktion „Turn on lights“ auswählen.
  10. Im fünften Schritt die zu schaltende Lampe auswählen und mit „create action“ bestätigen.
  11. Zum Schluss die Erstellung des Applets mit „finish“ bestätigen.
  12. Anschließen die angegebene URL unter https://ifttt.com/services/maker_webhooks/settings aufrufen.
  13. Auf der sich öffnenden Seite wird oben dein key angezeigt.
  14. In Connect den neuen WebHook anlegen mit folgender URL: https://maker.ifttt.com/trigger/Einsatz/with/key/dein_key
  15. Nach dem Anlegen kannst du deinen WebHook über den Play-Button testen.

Einrichtung Standort Webhook

Um einen Webhook anzulegen, melden Sie sich im Connect Portal an und wählen den Menüpunkt „Schnittstellen“ und „Standort Webhook“ aus. Legen Sie nun einen neuen Eintrag an. Wählen Sie aus, wann der Webhook ausgelöst werden soll und tragen Sie die entsprechende URL ein. Die URL des Servers, welches sie ansteuern müssen ist individuell und hängt von der eingesetzten Lösung ab. Die URL muss aus dem Internet erreichbar sein.

WebHook-URLs um Variablen ergänzen

Ergänzend können die URLs um folgende Platzhalter ergänzt werden, die beim Senden durch die entsprechenden Einsatzinformationen ergänzt werden:

  • {Kategorie} – Einsatzkategorie (Feuer / Hilfeleistung / etc.)
  • {Stichwort} – Einsatzstichwort
  • {Stichwortübersetzung} – Einsatzstichwort
  • {Standort} – Der Connect-Standort, der den Einsatz empfangen hat.
  • {Sachverhalt} – Sachverhalt bzw. Meldebild
  • {Adresse} – Vollständige Adresse des Einsatzortes
  • {Einsatz-ID} – Connect Einsatz ID
  • {RIC} – Alarmierten Einsatzmittel. Schleifen etc
  • {Alarmgruppen} – Alarmgruppen
  • {Infogruppen} – Alarmgruppen welche informiert wurden
  • {Fahrzeuge} – Fahrzeuge

Beispielsweise können Sie über den Webhook ein Script aufrufen welches über unsere Public API alle weiteren Infos abrufen kann. Hierbei kann die Einsatz ID aus dem Webhook mit der Variable {OperationID} verwendet werden.

Beispiel VoiceMonkey mit Standort Webhooks

In diesem Beispiel wird gezeigt, wie man Alexa mittels Webhook den Einsatz vorlesen lassen kann. Hierzu gibt es bereits eine separate Anleitung.

https://api.voicemonkey.io/trigger?access_token=<ACCESS_TOKEN>&secret_token=<SECRET_TOKEN>&monkey=<MONKEYNAME>&announcement=Einsatz%20Feuerwehr%20Flammenhausen%20-%20{Stichwortübersetzung}{Sachverhalt}{Adresse}&chime=soundbank%3A%2F%2Fsoundlibrary%2Falarms%2Fbeeps_and_bloops%2Ftone_02
Inhaltsverzeichnis