Webhooks benachrichtigen externe Dienstleistungen wie Chat-Clients oder andere externe APIs über Ereignisse. Ein Webhook kann eine URL festlegen, wenn ein bestimmtes Ereignis eintritt.
Phrase Orchestrator bietet eine Dienstleistung, die Benachrichtigungen von Drittsystemen überwacht und verarbeitet. Diese Dienstleistung ermöglicht es Usern, ihre Workflows mit einer Vielzahl externer Systeme zu verbinden, die HTTP-Anfragen unterstützen.
User können einen neuen Trigger für eingehende Webhooks von externen Ereignissen Erstellen, wobei das System automatisch eine eindeutige Webhook URL mit API Key für das Webhook Setup von Drittanbietern generiert. Die generierte Webhook URL ist eindeutig und direkt mit dem User-Konto und Workflow verknüpft, was bedeutet, dass jeder Webhook nur an einen Workflow gebunden ist.
Eingehenden Webhook konfigurieren
Um einen eingehenden Webhook zu konfigurieren, folgen Sie diesen Schritten:
-
Ziehen Sie einen -Trigger per Drag-and-Drop in einen Workflow.
Der Trigger erscheint im Workflow.
-
Klicke auf den Trigger, um den Tab zu öffnen.
-
Wählen Sie den -Tab auswählen.
-
Kopieren Sie die .
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 Payload mit Daten zur Verwendung innerhalb der Workflows zu senden, stellen Sie das Schema dieser Payload bereit.
-
Um ein Schema bereitzustellen, klicke auf Edit webhook.
-
auswählen:
JSON Schemas sind ein Standard für die Definition von JSON-Payloads. Wenn eine existierende Dienstleistung diese verwendet oder eine externe Dienstleistung, die eine Verbindung zu Orchestrator herstellt, eine bereitstellt, kopieren Sie diese unverändert.
-
JSON
Stellen Sie eine Beispiel-JSON-Payload für ein einfacheres Setup bereit, um das Testen des Webhook ohne die Definition exakter Regeln zu ermöglichen.
-
JSON Schema
Definieren Sie präzise die Struktur, Datentypen und Validierungsregeln für die JSON-Daten.
-
-
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, sobald er veröffentlicht wurde, senden Sie eine POST-Anfrage an die Webhook-URL. Für Workflows, die kein konfiguriertes Schema haben, muss der Body leer sein. Wenn ein konfiguriertes Schema angewendet wird, muss der Payload dem Match des Schemas entsprechen.
Benutzer können Workflows festlegen, die nicht nur Daten empfangen, sondern auch automatisch Updates an externe Systeme senden. Die Aktion für ausgehende Webhooks ermöglicht es Benutzern, automatisch bestimmte Aktionen in externen Systemen auszulösen.
Webhooks in anderen Diensten können durch die Aktion „HTTP-Anfrage senden“ ausgelöst werden.
Einen ausgehenden Webhook festlegen
Um einen ausgehenden Webhook festzulegen, befolgen Sie diese Schritte: