Mikroapps

Konfigurieren von Webhook-Listenern

Konfigurieren Sie Webhook-Listener (auch HTTP-Push-API genannt), um Endbenutzern Daten Ihrer Mikroapps nahezu in Echtzeit bereitzustellen. Durch Konfigurieren eines Webhooks erfolgt die Datenübertragung von Ihren Apps an andere Anwendungen wesentlich schneller als bei der Synchronisierung durch die Mikroappsplattform. Die maximale Größe eines Webhook-Anforderungstexts, der vom Mikroappserver verarbeitet werden kann, beträgt 64 KB.

Um Webhook-Listener hinzufügen, müssen Sie mit dem System of Record (SoR) Ihrer Zielanwendung vertraut sein und über die erforderlichen Tools und Administratorrechte verfügen, um Ihre Webhooks an diesen Standorten zu konfigurieren.

Konfigurieren Sie Ihre Webhooks, nachdem Sie die Integration über Daten laden eingerichtet haben und führen Sie folgende Schritte aus:

  1. Klicken Sie in der linken Leiste des HTTP-Integrationsfensters auf Webhook-Listener:

    Webhook-Listener

  2. Geben Sie einen Namen für den Webhook ein.
  3. Wählen Sie Kopieren, um die Webhook-URL zur späteren Verwendung in der Administrationsoberfläche Ihres Ziel-SoR zu kopieren.

Autorisierungsmethode

Als Autorisierungsmethode können Sie entweder Token oder Keine wählen. Führen Sie folgende Schritte aus, um die Autorisierungsmethode Token zu konfigurieren:

  1. Wählen Sie unter Autorisierungsmethode die Option Token.
  2. Wählen Sie Token generieren und dann Kopieren, um den Token später aus der Zwischenablage in der Administrationsoberfläche des Ziel-SoR einzufügen.
  3. Wählen Sie Token lesen aus und wählen Sie aus:

    • Benutzerdefinierter Header
    • Abfrageparameter
    • Autorisierungsheader
  4. Definieren Sie je nach ausgewählter Lesemethode entweder Name oder Präfix.

Der Token ist jetzt eingerichtet.

Anforderungsmethoden

Verwenden Sie beim Konfigurieren Ihrer Webhook-Listener die folgenden Definitionen, um Ihre Aufrufe zu erstellen:

  • PUT: Aktualisieren vorhandener Ressourcen.
  • POST: Erstellen neuer untergeordneter Ressourcen. POST-Methoden dienen daher zum Erstellen neuer Ressourcen in der Ressourcensammlung. PUT und POST löschen Daten aus untergeordneten Tabellen und verwenden dafür die Primärschlüsselinformationen aus der Stammtabelle. Ein vorhandener Datensatz wird ersetzt oder es wird ein neuer Datensatz eingefügt.
  • DELETE: Löschen von Ressourcen. DELETE hat zwei Endpunkte:
    • {serviceUuid}/{webhookListenerUuid}/{recordId}, wobei recordId der Wert des Primärschlüssels für den zu löschenden Datensatz in der Stammtabelle ist. Datensätze in der untergeordneten Tabelle werden entsprechend gelöscht.
    • {serviceUuid}/{webhookListenerUuid}/?id1=1&id2=1, wobei id1 und id2 die Werte des zusammengesetzten Primärschlüssels für den zu löschenden Datensatz in der Stammtabelle sind. Datensätze in der untergeordneten Tabelle werden entsprechend gelöscht.
  • PATCH-Anforderungen werden verwendet, um eine Ressource nur teilweise zu aktualisieren.

Definieren der Datenstruktur

Zum Definieren der Datenstruktur können Sie ein ähnliches Verfahren wie beim Abrufen der Datenstruktur während der Konfiguration des Datenladens verwenden. Weitere Informationen finden Sie unter Konfigurieren der Integration.

Führen Sie folgende Schritte aus, um Ihre Webhook-Datenstruktur zu definieren:

  1. Legen Sie den Aufbewahrungszeitraum fest. Alle Einträge, die vor diesem Datum erstellt wurden, werden gelöscht. Jeder gespeicherte Eintrag enthält Datum und Uhrzeit der Änderung. Dies ist lastModified. Anhand dieses Datums samt Uhrzeit wird entschieden, welche Einträge zu löschen sind.
  2. Wählen Sie Tabellen generieren.

    Das Fenster Tabellen generieren wird geöffnet.

    Fügen Sie hier Ihre JSON-Beispielanforderung aus dem System of Record (SoR) Ihrer Zielanwendung ein.

  3. Legen Sie den Basisnamen der erstellten Tabellen fest.
  4. (Optional) Legen Sie bei Bedarf den Stammpfad fest.
  5. Wählen Sie Generieren.

Wenn dieser Prozess und die Konfigurationsmaßnahmen in der Administration des System of Record (SoR) der Zielanwendung abgeschlossen sind, wählen Sie Hinzufügen.

Ihr Webhook ist jetzt konfiguriert.

Anzeigen von Webhook-Protokollen

Verwenden Sie Webhook-Protokolle, um einen Verlauf von Anforderungen und Fehlern von allen Webhook-Endpunkten anzuzeigen. Sie können nach Webhook-Namen und -Status (z. B. Erfolg, Fehler) filtern oder alle anzeigen. Zur Leistungsoptimierung werden nur die letzten 10 Webhook-Protokolleinträge im Webhook-Protokollbildschirm gespeichert.

  1. Wählen Sie auf der Seite zum Verwalten der Mikroapps das Menü neben der Integration aus, deren Integrationsprotokolle Sie anzeigen möchten.
  2. Wählen Sie Webhook-Protokolle.
  3. Überprüfen Sie die Einträge, und wählen Sie im Menü einen Filter nach Bedarf.
Konfigurieren von Webhook-Listenern