Konfigurieren IO Warnungsbenachrichtigungen für eine Drittpartei-Anwendung
Richten Sie eine grundlegende Integration zwischen ein Instance Observer( IO) Und Drittpartei-Integrationen, die weitergeleitet werden sollen IO Warnungsbenachrichtigungen an ein externes System zusätzlich zu E-Mails und SMS.
Vorbereitungen
Warum und wann dieser Vorgang ausgeführt wird
Bei Drittanbieterintegrationen können Webhook-URLs ablaufen, wenn ein Abonnement nicht verlängert wird, oder API-Schlüssel sind im Laufe der Zeit ungültig. Stellen Sie sicher, dass Ihre Anmeldeinformationen für die Integration auf dem neuesten Stand sind, um zu vermeiden, dass Warnmeldungen verpasst werden.
Prozedur
- Navigieren zu Auswirkung > Plattform Health > Monitor > Wechseln Sie zu Instance Observeran.
- Melden Sie sich bei an Instance Observer Und navigieren Sie zu Warnungen > Konfigurieren Sie Die Benachrichtigungan.
- Wählen Sie Aus + Integration Erstellen .
-
Füllen Sie im Formular die Felder aus.
Geben Sie für eine Drittpartei-Integration Folgendes ein:
Tabelle : 1. Erstellen Sie ein Integrationsformular Feld Beschreibung Integrationstyp Drittpartei. ServiceNow Ist standardmäßig ausgewählt. Integrationsname Name zur Identifizierung der Integration. Authentifizierungstyp Standardauthentifizierung oder ein API-Schlüssel für die Integration. Geben Sie für den API-Schlüssel den Schlüssel oder Anwendernamen und das Passwort für die Integration an.
Anwendername Anwendername, der der Integration zugeordnet ist. Passwort Passwort für die Integration. Geben Sie die URL ein Webhook-URL, wie in Ihrer Drittpartei-Anwendung (extern) konfiguriert. Weitere Informationen finden Sie unter Create a scripted REST API
-
Wählen Sie Aus Integration Testen Um Ihre Konfiguration zu validieren und zu überprüfen, ob Sie die Nutzlast erfolgreich an die konfigurierte Anwendung senden können.
Wenn Sie nicht über die richtigen URL-Details verfügen, können Sie die Integration unter speichern Entwurf Und kehren Sie zurück, um es später abzuschließen.
- Wenn der Test erfolgreich ist, erhalten Sie einen HTTP-Antwort 200 ist erfolgreich Antwort. Sie können jetzt mit dem übermitteln der Integration fortfahren.
- Wenn der Test fehlschlägt, wird eine Fehlermeldung rot angezeigt. Überprüfen und korrigieren Sie Ihre Integrationsdetails, z. B. Webhook-URL, Anwendername oder Passwort, und testen Sie sie erneut.Wichtig:Ein erfolgreiches Testergebnis ist erforderlich, bevor Sie die Integration übermitteln können. Wenn Sie versuchen, ohne Tests zu übermitteln, wird eine Validierungsnachricht angezeigt: Erfolgreiche Testintegrationsergebnisse sind erforderlich, um Ihre Integration zu übermitteln, oder speichern Sie sie als Entwurf, wenn Sie keine funktionierende URL haben.
-
Übermitteln Die Integration und speichern Sie sie, wenn der Test erfolgreich ist.
Die Integration wird mit einem Status erstellt Aktiviert .
-
Überprüfen Sie den Integrationsstatus.
In Integrationen Bestätigen Sie, dass der Integrationsstatus als angezeigt wird Aktiviert .Hinweis:Nur Integrationen mit Aktiviert Status wird in angezeigt Benachrichtigungsregeln Registerkarte zum Verknüpfen mit der Benachrichtigungsregel. Entwurfsintegrationen können erst ausgewählt werden, wenn sie abgeschlossen und aktiviert sind.
-
Wählen Sie aus, um eine Benachrichtigungsregel für die Drittpartei-Integration zu konfigurieren und Warnungen an Drittpartei-Anwendungen zu senden Benachrichtigungsregeln Registerkarte.
-
Wählen Sie Aus
Wählen Sie für die Benachrichtigungsregel aus, und wählen Sie aus Bearbeiten Option.
- Geben Sie einen Namen für die Regel in ein Name Feld des Popups „Regel bearbeiten“.
- Geben Sie eine Beschreibung für die Benachrichtigungsregel ein.
- Wählen Sie aus Drittpartei-Integration Option als Benachrichtigungstyp Und wählen Sie einen Wert aus der Liste aus.
- Wählen Sie Speichern.
-
Wählen Sie Aus
-
Überprüfen Sie die Bereitstellung der Warnungsnutzlast in Warnungskonsole Indem Sie zu navigieren Warnungen > Warnungskonsolean.
So bestätigen Sie, dass Ihre Integration ordnungsgemäß funktioniert, nachdem eine Warnung ausgelöst wurde:
- Wählen Sie Ihre Instanz und aus Snapshot Abrufen In Warnungskonsole .
-
Von Testwarnung Generieren Wählen Sie die von Ihnen konfigurierte Warnung aus.
Die von Ihnen konfigurierte Testwarnung wird in der Liste angezeigt. Beispiel: Datenbank-Antwortzeit Warnung in Ihrer Instanz.
-
Stellen Sie sicher, dass die Warnungsnutzlast erfolgreich an den konfigurierten Integrationsendpunkt übermittelt wurde, bei dem es sich um eine Drittparteiinstanz handelt.
Die Warnungsnutzlast erreicht die Drittparteiinstanz, solange die Webhook-URL die HTTP-Aufrufe akzeptiert.
-
Überprüfen Sie, ob die Warnung mit der angegebenen Nutzlast das beabsichtigte Ziel erreicht hat.
Wenn die Warnung fehlgeschlagen war, wird angezeigt, dass Warnungstyp Wird rot angezeigt, was bedeutet, dass der Fehler aufgetreten ist. Beim Auswählen von ist ein Fehler aufgetreten Selfservice Warnungssymbol Sie sehen die Nachricht Drittpartei-Integration – Fehlgeschlagen .
-
Um die URL im Popup „Integration bearbeiten“ anzuzeigen, zu bearbeiten oder zu löschen, navigieren Sie zurück zu Warnungen > Benachrichtigungen konfigurieren Und wählen Sie aus
Für die Integration.
Sie können die Integrationseinstellungen aktualisieren, indem Sie auswählen Bearbeiten Option. Die Löschen Die Option bleibt inaktiv, wenn die Integration mindestens einer Benachrichtigungsregel zugeordnet ist. -
Identifizieren und beheben Sie Integrationsfehler.
Wenn eine Integration fehlschlägt, nachdem sie aktiviert wurde, z. B. aufgrund einer abgelaufenen Webhook-URL, eines ungültigen API-Schlüssels oder abgelaufener Anmeldeinformationen, dann IO Erkennt den Fehler und kennzeichnet ihn zu Ihrer Aufmerksamkeit. So identifizieren und beheben Sie eine fehlgeschlagene Integration:
- In Warnungskonsole , Suchen Sie nach Warnungen, die unter rot angezeigt werden Warnungstyp Spalte. Ein roter Indikator bedeutet, dass die Warnungsnutzlast die Benachrichtigung nicht zugestellt hat.
- Wählen Sie aus Fehlgeschlagen Link zum Anzeigen der vollständigen Fehlerdetails. Beispiel: A 404 Fehler, der angibt, dass die URL ungültig ist oder der API-Schlüssel abgelaufen ist.
- Wählen Sie Aus Aktualisieren Sie Die Integration Um die Integration mit den richtigen Anmeldeinformationen oder Webhook-URL zu bearbeiten, testen Sie sie erfolgreich, und übermitteln Sie sie erneut, um die Integration in wiederherzustellen Aktiviert Status.
- Alternativ können Sie zu navigieren Warnungen > Konfigurieren Sie Die Benachrichtigung, Und wählen Sie die Integration mit dem Status „Fehlgeschlagen“ in aus Integration Registerkarte. Bearbeiten Die Integrationskonfiguration testet die Integration, und wenn sie erfolgreich ist, übermitteln Sie sie erneut, um die Integration auf den Status „aktiviert“ zurückzusetzen.
Die Löschen Die Option bleibt inaktiv, wenn die Integration mindestens einer Benachrichtigungsregel zugeordnet ist.
Wichtig:Solange die Integration nicht behoben und erneut aktiviert ist, werden Warnungsnutzlasten nicht an den fehlgeschlagenen Endpunkt übermittelt.- E/A-Warnungsbenachrichtigungskanäle
-
Sie können die Integrationsfehler an drei Stellen als Warnungen anzeigen:
- As Warnungstyp In Warnung > Warnungskonsole
- Als Benachrichtigungen von
. Wählen Sie Aus Benachrichtigungsverlauf Anzeigen Und filtern mit Integration Fehlgeschlagen .
- Als E-Mail-Benachrichtigung mit dem Integrationsnamen, der Fehlernummer und der Nachricht.