Konfigurieren von Webhooks

Webhooks liefern Daten an andere Anwendungen, die von bestimmten Alarmen mithilfe von HTTP POST ausgelöst werden. Wenn ein Alarm auftritt, sendet die Quelle eine HTTP-Anfrage an die zielseitige Anwendung, die für den Webhook konfiguriert ist. SD-WAN Orchestrator unterstützt Webhooks, die automatisch Nachrichten über HTTP POST an zielseitige Anwendungen senden, wenn ein Ereignis eintritt. Sie können die Ziel-URL im Unternehmensportal festlegen und Aktionen als Reaktion auf die von SD-WAN Orchestrator ausgelösten Alarme automatisieren. Die Webhook-Empfänger müssen HTTPS unterstützen und über gültige Zertifikate verfügen, um den Datenschutz potenziell sensibler Alarmnutzlasten zu gewährleisten. Dadurch wird auch verhindert, dass Nutzlasten manipuliert werden.

Auf der Seite Webhooks im Fenster Alarmkonfiguration (Alert Configuration) können Sie die folgenden Details konfigurieren:

Option	Beschreibung
URL	Geben Sie eine gültige HTTPS-URL ein. Diese dient als Zielanwendung für die Webhooks.
Code	Geben Sie für jeden Webhook-Empfänger einen erwarteten HTTP-Antwortstatuscode ein. Standardmäßig erwartet die SD-WAN Orchestrator-Instanz, dass Webhook-Empfänger auf HTTP-POST-Anfragen mit einem Statuscode wie HTTP 200 antworten. Wenn die SD-WAN Orchestrator-Instanz einen unerwarteten Statuscode von einem Empfängerserver oder Proxyserver empfängt, geht sie davon aus, dass die Alarmübergabe fehlgeschlagen ist, und generiert ein ALERT_DELIVERY_FAILED-Kundenereignis. Dieses Ereignis hilft zu erkennen, wenn ein Webhook-Empfangsserver möglicherweise nicht wie erwartet funktioniert.
Geheim (Secret)	Geben Sie für jeden konfigurierten Webhook-Empfänger ein geheimes Token an, das zur Berechnung eines HMAC-Werts für jede an den entsprechenden Empfänger gesendete Webhook-Anforderung verwendet wird. Der HMAC-Wert ist in einen X-Webhook-Signature-HTTP-Header mit einem Versionsparameter eingebettet, der den Signaturalgorithmus und einen Zeitstempel identifiziert. X-Webhook-Signature: v=<signature-version>&t=<timestamp>&s=<hmac> Der Empfänger interpretiert die Komponenten wie folgt: v: Version des Algorithmus, der für die Erstellung der Signatur verwendet wird. Der einzige unterstützte Wert ist 1. t: Zeitraum-Zeitstempel auf Millisekundenpräzision, der dem Zeitpunkt entspricht, zu dem die Anforderung gesendet wird. s: Von SD-WAN Orchestrator berechneter HMAC-Wert. Der HMAC-Wert wird wie folgt berechnet: HMAC-SHA256(request-body + '.' + timestamp, secret). Die Nachricht, die zur Berechnung des HMAC-Werts verwendet wird, wird durch Verkettung des Anforderungstexts, einer einzelnen Periode und des Wertes des Zeitstempelparameters, der im Signaturkopf erscheint, gebildet. Der spezifische HMAC-Algorithmus, der zum Erstellen des Codes verwendet wird, lautet SHA256. Nach dem Empfang einer Webhook-Anforderung kann der abhörende Server die Authentizität der Anforderung überprüfen, indem er seine eigene HMAC-SHA256-Signatur nach demselben Algorithmus berechnet und die neu berechnete Signatur mit der von der SD-WAN Orchestrator-Instanz.
JSON-Nutzlastvorlage (JSON Payload Template)	Dies ist ein erforderliches Feld. SD-WAN Orchestrator liefert Alarmbenachrichtigungen an jeden Webhook-Empfänger über eine JSON-Nutzlast, die im Text einer ausgehenden HTTP-POST-Anforderung enthalten ist. SD-WAN Orchestrator generiert den Inhalt der Nutzlast dynamisch, da die Benachrichtigungen durch variable Interpolation gesendet werden. Die unterstützten Platzhaltervariablen in der benutzerkonfigurierten Nutzlastvorlage werden durch alarmspezifische Werte ersetzt.
Überprüfen	Klicken Sie auf diese Option, um die eingegebenen Details zu validieren.

Klicken Sie auf den Link Nutzlastvorlage konfigurieren (Configure Payload Template) unter der Option JSON-Nutzlastvorlage (JSON Payload Template), um Folgendes zu konfigurieren:

Option	Beschreibung
Alarmzeit	Geben Sie das Datum und die Uhrzeit ein, zu denen die Warnung ausgelöst werden muss.
Warnungstyp	Wählen Sie den Alarmtyp aus dem Dropdown-Menü aus. Standardmäßig wird er als Nicht verfügbar (N/A) angezeigt.
Logische Kunden-ID	Geben Sie die logische ID des Kunden ein, an den die Benachrichtigung gesendet werden muss.
Kunde	Geben Sie den Namen des Kunden ein, an den die Benachrichtigung gesendet werden muss.
Logische Geräte-ID	Geben Sie die logische ID des Edge ein, auf den die Warnung angewendet werden muss.
Gerätebeschreibung	Geben Sie eine kurze Nachricht ein, die den Edge beschreibt, auf den der Alarm angewendet werden muss.
Gerät-Seriennummer	Geben Sie die Seriennummer des Edge ein, auf den der Alarm angewendet werden muss.
Gerätename	Geben Sie den Namen des Edge ein, auf den der Alarm angewendet werden muss.
Letzter Kontakt (Last Contact)	Geben Sie das Datum und die Uhrzeit an, zu der der betroffene Edge zuletzt mit dem SD-WAN Orchestrator kommuniziert hat. Dies gilt nur für die Edge-Alarme.
VCO	Geben Sie den Hostnamen oder die öffentliche IP-Adresse des SD-WAN Orchestrator ein, von dem die Benachrichtigung gesendet werden soll.
Nachricht (Message)	Eine kurze Nachricht, die das Ereignis beschreibt, das den Alarm auslösen muss.
Betroffene Entität	Geben Sie den Namen der Einheit ein: Edge oder Link oder VNF, auf die der Alarm angewendet werden muss.

Das folgende Beispiel zeigt ein Beispiel einer JSON-Nutzlastvorlage:

{
   "alertTime": "alertTime",
   "alertType": "alertType",      
   "customer": "customer",
   "customerLogicalId": "customerLogicalId",
   "entityAffected": "entityAffected",
   "deviceLogicalId": "deviceLogicalId",
   "lastContact": "lastContact",
   "message": "message",
   "vco": "vco",
   "deviceName": "deviceName",
   "deviceDescription": "deviceDescription",
   "deviceSerialNumber": "deviceSerialNumber"
}

Klicken Sie auf Speichern (Save) und dann auf Änderungen speichern (Save Changes) auf der Seite Webhooks, um die Webhook-Konfigurationen zu speichern.

Immer dann, wenn ein Alarm ausgelöst wird, wird eine Alarmmeldung zusammen mit den relevanten Informationen an die Ziel-URL gesendet.