Webhooks benachrichtigen externe Dienstleistungen wie Chat-Clients oder andere externe APIs über Ereignisse. Ein Webhook kann eine URL setzen, wenn ein bestimmtes Ereignis eintritt.
Phrase Orchestrator stellt eine Dienstleistung bereit, die Benachrichtigungen von Drittanbietersystemen überwacht und verarbeitet. Mit diesem Dienst lassen sich Workflows mit einer Vielzahl von externen Systemen verbinden, die HTTP-Anfragen unterstützen.
Es kann ein neuer Trigger für eingehende Webhooks von externen Ereignissen erstellt werden, wobei das System automatisch eine eindeutige Webhook-URL mit API-Key für das Drittanbieter-Webhook-Setup generiert. Die generierte Webhook-URL ist einzigartig und direkt mit dem User-Konto und Workflow verknüpft, was bedeutet, dass jeder Webhook nur mit einem Workflow verbunden ist.
Eingehenden Webhook konfigurieren
Um einen eingehenden Webhook zu konfigurieren, sind die folgenden Schritte auszuführen:
-
Per Drag & Drop wird ein -Trigger in einen Workflow eingefügt.
Der Trigger erscheint im Workflow.
-
Klicke auf den Trigger, um den Tab zu öffnen.
-
Der -Tab wird ausgewählt.
-
Die wird kopiert.
Diese URL sollte als geheim betrachtet und nicht geteilt werden. Wenn du es versehentlich geteilt hast, klicke auf Regenerate, um ein neues zu erstellen und das vorhandene ungültig zu machen.
-
Um eine Nutzlast mit Daten zu senden, die in den Workflows verwendet werden soll, ist das Schema dieser Nutzlast anzugeben.
-
Um ein Schema bereitzustellen, klicke auf Edit webhook.
-
auswählen:
JSON Schemas sind ein Standard zur Definition von JSON-Nutzlasten. Wenn ein vorhandener Dienst, der sie verwendet, oder ein externer Dienst, der mit dem Orchestrator verbunden ist, eines bereitstellt, wird dieses unverändert kopiert.
-
JSON
Eine Beispiel-JSON-Nutzlast für eine einfachere Einrichtung, die das Testen des Webhooks ohne genaue Regeldefinition ermöglicht, ist anzugeben.
-
JSON Schema
Die Struktur, die Datentypen und die Validierungsregeln für die JSON-Daten sind präzise festzulegen.
-
-
Klicke auf Save payload schema.
Eine Vorschau der erwarteten Datenstruktur für den Webhook-Trigger wird angezeigt.
-
-
Falls erforderlich, öffne den Tab , um Filter zum Trigger hinzuzufügen.
-
Um einen Workflow auszulösen, nachdem er veröffentlicht wurde, muss eine POST-Anfrage an die Webhook-URL gesendet werden. Für Workflows, die kein konfiguriertes Schema haben, muss der Body leer sein. Wenn ein konfiguriertes Schema angewendet wird, muss die Nutzlast mit dem Schema übereinstimmen.
Mit Workflows kann festgelegt werden, dass nicht nur Daten empfangen, sondern auch automatisch Aktualisierungen an externe Systeme gesendet werden. Die Aktion für ausgehende Webhooks ermöglicht das automatische Auslösen bestimmter Aktionen in externen Systemen.
Webhooks in anderen Dienstleistungen können durch die Aktion Send HTTP Request ausgelöst werden.
Einen ausgehenden Webhook konfigurieren
Um einen ausgehenden Webhook zu konfigurieren, sind die folgenden Schritte auszuführen: