WEBHOOK-Ereignisse

Als Benutzer der Automation und Event Engine können Sie mit dem Webhook-Ereignisobjekt Ihren eigenen Endpunkt erstellen, um Ereignis-Payloads von externen Systemen oder Sensoren zu empfangen. Sobald das Webhook-Objekt konfiguriert ist, kann es beliebige über HTTP empfangene JSON-Nachrichten verarbeiten. Die Funktion Webhook-Ereignisobjekt erleichtert die Integration externer Systeme und verhindert den Aufbau eines bestimmten Kollektors.

Es gibt einige Voraussetzungen, die Sie beachten müssen, bevor Sie das Webhook-Ereignis verwenden, siehe:

Eine Installation von Analytics mit der Rule Engine. Siehe: Analytics manuell installieren
Das Analytics Action Pack, Rule Pack und AWI Plug vom Marketplace

Diese Seite beinhaltet Folgendes:

Webhook-Ereignisobjekt Anwendungsfälle

Es kann zur Integration mit Systemen verwendet werden, die Webhooks unterstützen. Sobald Ihre Systemintegration konfiguriert ist, können Sie Ereignisse und Benachrichtigungen in Echtzeit empfangen und verarbeiten.

Systeme aus der Praxis, bei denen eine Ereignisbenachrichtigung in Echtzeit von Vorteil sein kann:

Ticket-Management-Systeme – Kundenaufträge, Lieferungen usw.
Monitoring-Tools – Alarme, Vorfälle und Erinnerungen
CRM-Systeme – neue Kundeninformationen und Verkaufsupdates

Webhook-Ereignisse können auch mit jeder Anwendung verwendet werden, die JSON-Nachrichten über HTTP senden kann. Sie können Ihre eigenen Sensoren bauen und die Daten an einer zentralen Stelle verarbeiten.

Webhook-Ereignisobjekt Übersicht

Die folgende Übersicht beschreibt die UI-Beschriftungen und die Funktionsweise des Webhook-Objekts.

Weitere Informationen finden Sie unter Webhook-Ereignisse aus externen Systemen integrieren.

Endpunktinformation (Pfad)

Das Webhook-Objekt verwendet den IA-Agenten (wenn ausgeführt), um auf eine bestimmte URL zu hören und auf eingehende Payloads in Echtzeit zu reagieren. Die URL ist wie folgt aufgebaut:

IA Automation Agent Adresse/ + "analytics/api/" + Version der API (derzeit "v1") + Kundennr. /+eindeutige Nr.

Der Pfad besteht aus:

Die Automation Engine-Mandanten-ID, in dem das Objekt erstellt wurde
Eine eindeutige, generierte Zahl

Beispiel

/analytics/api/v1/100/1003106

Hinweise:

Der Pfad kann nicht bearbeitet werden
Der Pfad ist für jedes Webhook-Ereignisobjekt eindeutig

Zur Ereignisdefinition zuordnen

Ereignisdefinition

Die Ereignisdefinition ist der Grundbaustein der Event Engine. Sie repräsentiert die Ereignisstruktur, die die Event Engine verwendet, um Regeln auszulösen und Workflows auszuführen etc. Eine Ereignisdefinition sollte aus der Benutzeroberfläche ausgewählt und auf das Webhook-Ereignisobjekt angewendet werden, das Sie für den Empfang von Daten konfiguriert haben.

Die Attributschlüssel der Ereignisdefinition sollten auf der erwarteten Ereignis-Payload des externen Systems basieren. Wie bereits erwähnt, sollten Sie einige Vorkenntnisse über das eingehende JSON-Nachrichtenschema haben.

Die Zuordnung ist notwendig, da die Regellogik der Event Engine nur bei Ereignissen im Format „Ereignisdefinition“ funktioniert. Regeln werden ausgelöst, sobald die Ereignisdefinition der empfangenen Nachricht zugeordnet ist. Für die Zuordnung müssen Sie den Inhalt der eingehenden Ereignis-Payload sowie das Schema und die JSONPath-Syntax kennen. Der Zuordnungsprozess erfordert die Transformation der empfangenen strukturierten Daten in eine flache Struktur im Webhook-Ereignisblatt.

Hinweis: Die Zuordnung ist ausführlich in Webhook-Ereignisse aus externen Systemen integrieren beschrieben.

Mit Hilfe der Funktion Zuordnung hinzufügen können auch mehrere externe Systemereignistypen integriert werden. Dafür können Sie dieselbe Webhook-URL (Endpunkt) in Ihrem externen System für mehrere Ereignistypen registrieren.

Weitere Informationen finden Sie unter IA-Ereignis-VARA-Objekte .

Wichtig! Vorkenntnisse über das JSON-Schema Ihres externen Systems sind erforderlich, da sonst die Abbildung eingehender Nachrichten zeitaufwendig und schwierig ist.

Empfangene Daten filtern

Sobald die JSON-Nachricht empfangen wurde, ordnen Sie die Daten Ihren zuvor erstellten Attributschlüsseln der Ereignisdefinition zu.

Der Filter besteht aus einer Reihe von Bedingungen, die beim Empfang der Ereignis-Payload ausgewertet werden. Wenn alle Bedingungen erfüllt sind, wird die Nachricht der ausgewählten Ereignisdefinition zugeordnet und von der Event Engine verarbeitet.

Jede Bedingung besteht aus drei Teilen:

JSON-Pfadausdruck, der Daten aus der empfangenen Payload auswählt
Operator, der auf die Daten der restlichen Schritte angewendet wird
Zur Verfügung gestellter Textwert, der mit dem Ergebnis des JSON-Pfadausdrucks unter Verwendung des im vorherigen Schritt ausgewählten Operators verglichen wird

Hinweis: Die JSON-Nachricht kann jedes beliebige Format haben.

So führen Sie eine Regel aus

Wählen Sie die Seite Attribute im Rule-Ereignisobjekt.
Wählen Sie den IA-Agenten aus dem Kombinationsfeld Agent und klicken Sie auf Speichern.

Klicken Sie auf Ausführen, um die Regel auszuführen.

Hinweis: Wenn Sie eine Regel abbrechen oder erneut anwenden, wird der Speicher der Event Engine gelöscht.

Webhook-Endpunkt sichern

Der Webhook läuft auf dem IA-Agenten und verwendet die gleichen TLS/SSL-Einstellungen. Wenn Sie für jedes Webhook-Objekt unterschiedliche Zertifikate verwenden möchten, müssen Sie mehrere IA-Agenten installieren und das Zertifikat auf jedem Agenten verwenden.

Weitere Informationen finden Sie unter -Backend sichern.