rest_api_logo

Mobile Alarmierung zu Anwendungen per WebHook oder REST API hinzufügen

ea_mobilealert

Die Enterprise Alert REST-API ist für eine komfortable Integration mit einer Vielzahl von Drittanbieter-Anwendungen konzipiert. Zur Übermittlung von Ereignissen an Enterprise Alert werden  HTTP POSTs mit beliebigem(!) JSON/XML/Textbody verwendet, welcher Ereignisdetails und -parameter enthält. Die API ist äußerst flexibel auf Ihre Bedürfnisse anpassbar, da sie kein spezielles Format benötigt. Stattdessen können Sie das Format Ihres Quellsystemes (z. B. VMware, Splunk, OMS usw.) ohne jegliche Änderung, an Nachricht oder API, einfach an Enterprise Alert weiterleiten lassen.

Für jedes dieser Systeme können Sie im Systemabschnitt von Enterprise Alert eine eigene REST-Ereignisquelle erstellen. Die Authentifizierung zwischen Quellsystem und Enterprise Alert kann über einen API-Key oder auch Basic Authentication erfolgen. Weitere Einzelheiten finden Sie in unserem aktualisierten Dokument Erste Schritte.

Die Enterprise Alert REST-API wird inklusive der Online-Dokumentation von OpenAPI (“Swagger”) und einem Swagger UI “API Explorer” bereitgestellt. Sie können Swagger aus der REST Eventquelle heraus öffnen, um so an die API-Beschreibung zu gelangen. Sie enthält Authentifizierungsdetails und ermöglicht es Ihnen, die API von Ihrem Webbrowser aus zu testen. Wie bereits erwähnt, ist die REST-API derzeit ausschließlich auf den Empfang von Ereignissen von Ihren Drittsystemen beschränkt, um automatische Benachrichtigungen an die zuständigen Ziele innerhalb Enterprise Alerts auszulösen. Wir wollen jedoch mittelfristig weitere Handler hinzufügen, z.B. für die Nutzerverwaltung oder den Abruf von Warnmeldungen. Die REST-API ist Teil der OpenAPI-Edition oder jeder “höheren” Edition von Enterprise Alert.

Integrationsvorteile:

  • Qualifizierte und zuständige Mitarbeiter werden direkt über Push, SMS, Telefonanrufe und/oder E-Mails benachrichtigt
  • Mitarbeiter können direkt Alarme quittieren und die Verantwortung für kritische Ereignisse übernehmen
  • Nicht beantwortete Alarme werden anhand vordefinierter Eskalationsketten weitergeleitet
  • Bereitschaftsplanung stellt sicher, dass Alarme die richtigen Leute zur richtigen Zeit erreichen

Einsatzszenarien:

  • 24/7 IT-Betrieb
  • Alarmierung von Rufbereitschaften
  • Alarmierung von Anwendern und Stakeholdern

Wie wird's gemacht

Eine Rest API in Enterprise Alert anlegen

  1. Navigieren Sie in Enterprise Alert zu System -> Event Sources.
  2. Auf der Event Source Seite klicken Sie am unteren Ende der Seite auf New Source.
  3. Wählen Sie REST API Client vom Dropdown Menü, vergeben Sie einen Namen für diese Eventquelle und sichern Sie sich den API Key an einem separaten Ort, da wir diesen Key für die nächsten Schritte benötigen. Sichern Sie Ihre Konfiguration, indem Sie auf Save klicken.
  4. Klicken Sie auf REST API Dokumentation in der Box rechts.
  5. Wählen Sie POST und tragen Sie den API Key aus Schritt 3 ein.
  6. Klicken Sie rechts auf das Beispiel unter Model | Example Value, um so das Event zu füllen.
  7. Wenn Sie auf den Try it out! Button klicken, löst das Swagger Tool ein Event mit den eingetragenen Parametern an Enterprise Alert aus. Diese können Sie unter Alarme > Eingegangene Ereignisse finden.

In Enterprise Alert können Sie auf dem Dashboard der rechten Seite die Endpunkte finden. Kopieren Sie von dort die REST API URL und kombinieren Sie ihn mit dem zuvor gesicherten API Key, diesen fügen Sie am Ende der URL hinter “apiKey=” ein.

Anlegen von Alarmierungen in Enterprise Alert basierend auf WebHook/REST API Ereignissen

Um aus den Events, die über die zuvor erstellte REST Eventquelle eingehen, Alarmierungsrichtlinien zu erstellen, befolgen Sie bitte die folgenden  Schritte:

  1. Navigieren Sie zu Alarme -> Eingegangene Ereignisse.
  2. Wählen Sie ein eingehendes Ereignis, das sie an Nutzer weiter eskalieren wollen und klicken Sie auf “Create Policy From Event”.
  3. Benennen Sie die Alarmierungsrichtlinie zur einfacheren Verwaltung um. Kicken Sie auf Weiter.
  4. Die Alarmierungsrichtlinie wird mit allen verfügbaren Parametern als Trigger-Bedingung angelegt. Um eine sinnvoll funktionierende Richtlinie zu erhalten, entfernen Sie bitte alle Parameter, die nur einmalig zutreffen z.B.: Zeitstempel oder IDs. Je nach Bedarf, können Sie noch weitere Parameter entfernen, um den Scope der Richtlinie zu erweitern. Einschränken können Sie ihn wiederum durch das Hinzufügen von Bedingungen. Abschließend klicken Sie auf Weiter.
  5. Wählen Sie den Nutzer/ das Team, welches Sie alarmieren wollen und wählen Sie aus, wie Sie das Team benachrichtigen wollen. Sofern gewünscht, können Sie hier auch mehrere Eskalationsstufen einrichten. Klicken Sie auf Weiter.
  6. Tragen Sie einen Betreff und einen Mitteilungstext ein, den Sie an ihre Nutzer kommunizieren wollen. Enterprise Alert bietet auch die Möglichkeit, sogenannte dynamische Inhalte zu verwenden. Dies erlaubt Ihnen, Parameter von vom Quellereignis dynamisch in Ihre Benachrichtigungen zu übernehmen. Klicken Sie auf Speichern.

Alarmierungen innerhalb der Enterprise Alert App

Die Enterprise Alert App erlaubt es Nutzern, ihre Alarme einfach einzusehen und zu bearbeiten, ohne sich zuvor im Web Portal einzuloggen. Untenstehend finden Sie ein Beispiel für Alarmdetails eines offenen Alarms und einen geschlossenen Alarm in unserer App.