WebHook Integration

Die WebHook Integration App ermöglicht es der DataEngine, WebHooks von externen Systemen zu empfangen und in Echtzeit auf Ereignisse zu reagieren. Dadurch können Daten von verschiedenen Plattformen automatisch in die MARINI Plattform integriert werden, ohne manuelle Eingriffe. Dies erleichtert die Automatisierung von Prozessen und die Verbindung von Drittanbieter-Tools mit der Plattform. Die App kann flexibel konfiguriert werden, um eine Vielzahl von WebHooks und Integrationsmöglichkeiten zu unterstützen.

Installation

Um die Webhook App zu verwenden, führe die folgenden Schritte aus:

  1. Erstelle ein Modul (oder verwende ein bereits existierendes Modul) in der DataEngine. Für die optimale Verwendung der Webhook App wird empfohlen, bestimmte Felder in diesem Modul zu erstellen:
    • rawjson (optional): Dieses Feld enthält den Inhalt der Anfrage als JSON-String.
    • path: Dieses Feld enthält den Pfadteil (den xxx/xxx-Teil) aus dem POST-Request.
    • Die JSON-Anfrage wird analysiert und sucht nach Feldern mit denselben Namen wie den Eigenschaften im JSON. Zum Beispiel wird das JSON {"EventType":"aaa"} das Feld userId setzen, wenn es existiert.
    • Wenn das JSON Objekte/Arrays enthält, können diese mit einem Unterstrich im Feldnamen angesprochen werden. Zum Beispiel kann {"Properties":{"ClientId":"aaa"}} über den Feldnamen properties_clientid zugegriffen werden.
    • Die Feldnamen im Bean können in beliebiger Groß- und Kleinschreibung vorliegen. Auch benutzerdefinierte Felder werden überprüft, sodass sie beispielsweise auch properties_ClientId_c sein können.
    • Ein Feld namens properties kann einen JSON-String enthalten, z.B. {"ClientId":"aaa".
    • Benutzerdefinierte Konfigurationen können für lange Feldnamen verwendet werden.
  2. Besuche /index.php?entryPoint=WebhookToken, um einen Zugriffstoken (Access Token) zu erhalten.

Absender (Sender)

Der Sender (Absender) des Webhooks kann POST-Anfragen an folgende URL senden:

  • http://web.dataengine.docker/entrypoint/Webhook
  • ODER
  • http://web.dataengine.docker/entrypoint/Webhook/xxx/xxx (wobei xxx/xxx der Pfad ist)

Du solltest die folgenden Header in deiner POST-Anfrage verwenden:

  • Content-Type: application/json
  • Authorization: Bearer <Access Token> (ersetze <Access Token> durch deinen erhaltenen Zugriffstoken)
  • X-Signature (optional): <HMAC-Hash des Inhalts>

Der Webhook wird immer eine neue Bean in der DataEngine erstellen. Dabei wird der Benutzer erstellt, der beim Erstellen des Zugriffstokens definiert wurde. Das Modul der Bean ist ebenfalls dasjenige, das beim Erstellen des Zugriffstokens definiert wurde. Die Felder der Bean werden gemäß den oben beschriebenen Regeln gefüllt.

Durch die Verwendung der DataEngine Webhook App kannst du problemlos Daten aus externen Diensten in die DataEngine integrieren und so die Effizienz deiner Datenverarbeitung steigern.

Diese App muss abhängig von den eingerichteten Modulen konfiguriert werden. Weitere Informationen findest du unter https://marini.systems/de/help-center/docs/custom-config/#WebHook.