Webhook

Der Webhook-Trigger empfängt JSON und andere Daten im Body einer HTTP POST-, PUT- oder DELETE-Request-Nachricht.

Damit der Webhook einen JSON-formatierten Request-Body erhält, müssen Sie das Nachrichtenschema so konfigurieren, dass es mit den erwarteten Daten übereinstimmt (siehe Ausgabeattribute, unten).

Der Webhook-Trigger verfügt über zwei Ausgabe-Ports. Der Success-Port () kann eine Nachricht senden, wenn der Trigger erfolgreich ausgelöst hat. Der Failure-Port (x) kann eine Nachricht senden, wenn der Trigger fehlschlägt.

Parameter

  • Webhook-URL: Die URL des Webhooks. Dieser Parameter wird beim Speichern des Workflows automatisch generiert. Nach der Generierung können Sie zum Kopieren auf das Zwischenablage-Symbol klicken.
  • Authentifizierung erforderlich: Wenn diese Option aktiviert ist, muss der Benutzer, der auf die Webhook-URL zugreift, über eine Webhook-Berechtigung für den Webhook-Trigger verfügen.

Attribute der Ausgabe

Siehe auch

Konfigurieren des Webhook-Schemas

Damit der Webhook einen JSON-formatierten Request-Body empfängt, müssen Sie das Nachrichtenschema wie folgt konfigurieren, damit es mit den erwarteten Daten übereinstimmt:

  1. Klicken Sie in der Registerkarte Ausgabeattribute auf Parameter aus JSON importieren.
  2. Geben Sie im Dialogfeld "Parameter aus JSON importieren" ein gültiges JSON-Schema ein und klicken Sie auf Parsen.
  3. Hinweis  Der Parser analysiert nur Schlüssel der obersten Ebene. Um auf den Inhalt verschachtelter Arrays und Objekte von einem Workspace aus zuzugreifen, verwenden Sie JSON-Manipulations-Transformer.

Die importierten Parameter erscheinen unter "Webhook-Attribute" mit dem Präfix der übergeordneten Webhook-Eigenschaft.

Weitere Attribute

Attribut Beschreibung
time Ereigniszeit
source Ereignistyp
error.type

(nur Failure-Port) Fehlertyp:

  • InvalidMessage: Beim Konfigurieren dieser Komponente ist ein Fehler aufgetreten, z. B. fehlende oder fehlerhafte Werte.
  • DeadLetter: Bei der Verbindung mit einer externen Ressource ist ein Fehler aufgetreten. Beispiele können Verbindungsprobleme, ungültige Anmeldeinformationen oder allgemeine Ausnahmen für externe Ressourcen sein.
error.message (nur Failure-Port) Fehlermeldung
message (nur Success-Port) Inhalt der Nachricht
webhook.headers (nur Success-Port) Die Kopfzeilen der HTTP-Anfrage in Form einer JSON-Zeichenfolge.
webhook.method (nur Success-Port) Die HTTP-Request-Methode, die den Webhook ausgelöst hat: POST, PUT oder DELETE.

Arbeiten mit Nicht-JSON-Daten

Zusätzlich zu JSON-formatierten Daten können Webhook-Trigger auch Text-, XML- und andere Daten empfangen. Die folgende Tabelle erläutert, wie Nicht-JSON-Daten für die Ausgabe von Attributen formatiert werden.

Content-Type

Nachrichtenkodierung

text/* Verbleibt im Text des Attributs message.
application/xml Als Text für das Attribut messageformatiert.
application/x-www-form-urlencoded Als Text für das Attribut messageformatiert.
application/* oder andere Base64 im Attribut message.