Webhooks benachrichtigen externe Dienste wie Chat-Clients oder andere externe APIs über Ereignisse. Ein Webhook kann eine URL festlegen, wenn ein bestimmtes Ereignis eintritt.
Der Phrase Orchestrator bietet einen Dienst, der Benachrichtigungen von Drittanbietersystemen überwacht und verarbeitet. Dieser Dienst ermöglicht es Benutzern, ihre Workflows mit einer Vielzahl von externen Systemen zu verbinden, die HTTP-Anfragen unterstützen.
Benutzer können einen neuen Trigger für eingehende Webhooks von externen Ereignissen erstellen, wobei das System automatisch eine eindeutige Webhook-URL mit API-Schlüssel für die Drittanbieter-Webhooks einrichtet. Die generierte Webhook-URL ist einzigartig und direkt mit dem Benutzerkonto und Workflow des Benutzers verbunden, was bedeutet, dass jeder Webhook nur an einen Workflow gebunden ist.
Eingehenden Webhook konfigurieren
Um einen eingehenden Webhook zu konfigurieren, befolge diese Schritte:
-
Ziehe einen -Trigger in einen Workflow.
Der Trigger erscheint im Workflow.
-
Klicke auf den Trigger, um den -Tab zu öffnen.
-
Wähle den -Tab aus.
-
Kopiere die .
Diese URL sollte als geheim betrachtet und nicht geteilt werden. Wenn sie versehentlich geteilt wurde, klicke auf Regenerate, um eine neue zu erstellen und die vorhandene ungültig zu machen.
-
Um eine Nutzlast mit Daten zu senden, die in den Workflows verwendet werden sollen, gib das Schema dieser Nutzlast an.
-
Um ein Schema bereitzustellen, klicke auf Edit webhook.
-
Wähle einen aus:
JSON-Schemas sind ein Standard zur Definition von JSON-Nutzlasten. Wenn ein vorhandener Dienst, der sie verwendet, oder ein externer Dienst, der eine Verbindung zum Orchestrator herstellt, einen bereitstellt, kopiere ihn unverändert.
-
JSON
Stelle eine Beispiel-JSON-Nutzlast für ein einfacheres Setup bereit, um den Webhook zu testen, ohne genaue Regeln festzulegen.
-
JSON Schema
Definiere 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 Arbeitsablauf auszulösen, nachdem er veröffentlicht wurde, sende eine POST-Anfrage an die Webhook-URL. Für Arbeitsabläufe, die kein konfiguriertes Schema haben, muss der Body leer sein. Wenn ein konfiguriertes Schema angewendet wird, muss die Nutzlast mit dem Schema übereinstimmen.
Benutzer können Arbeitsabläufe einrichten, die nicht nur Daten empfangen, sondern auch automatisch Updates an externe Systeme senden. Die Aktion für ausgehende Webhooks ermöglicht es Benutzern, spezifische Aktionen in externen Systemen automatisch auszulösen.
Webhooks in anderen Diensten können über die Aktion "HTTP-Anfrage senden" ausgelöst werden.
Konfiguriere einen ausgehenden Webhook
Um einen ausgehenden Webhook zu konfigurieren, folge diesen Schritten: