Webhooks

Ein Webhook ist eine URL, über die ein externes System bei einem bestimmten Ereignis automatisch Daten an eine andere Anwendung senden kann. Dadurch lassen sich Prozesse ohne manuelles Eingreifen direkt anstoßen und Informationen in Echtzeit übergeben.

Einrichtung

Personal Access Token (PAT)

Erstellen Sie in Ihren persönlichen Einstellungen ein Personal Access Token (PAT).

Einen PAT erstellen Dieser Token identifiziert den Nutzer beim Aufruf einer Webhook-URL. Das Token kann für alle Webhooks des Accounts verwendet werden.

Das PAT kann beim Aufruf der Webhook-URL im Header (empfohlen, X-Synesty-PAT: <your personal access token>) oder als URL-Parameter (<webhook url>?x_synesty_pat=<your personal access token>) angegeben werden. Wenn möglich, verwenden Sie den Header, da URL-Parameter häufig in Logs/Browser-Historien gespeichert werden.

Webhook erstellen und konfigurieren

Legen Sie in der Webhook-Übersicht einen neuen Webhook an. Anschließend kann der Webhook konfiguriert werden.

Webhook Konfigurieren

Webhook Ziel

Als Konfigurieren Sie, ob der Webhook Daten in einen Datastore schreiben oder einen Flow starten soll. Die Request-Parameter können dabei auf Flow-Variablen oder Datastore-Spalten gemappt werden.

Flow Trigger

Das “Flow Trigger” Ziel ermöglicht es, einen Flow bei einer Webhook-Anfrage auszuführen. Wählen Sie zunächst ein Projekt und den Flow aus, der ausgeführt werden soll. Bei dieser Zielart wird der Flow pro Webhook-Anfrage einmal ausgeführt. Sollte der Flow bei einer Anfrage bereits ausgeführt werden, wird diese zunächst bei den Webhook-Anfragen gespeichert und zum nächstmöglichen Zeitpunkt verarbeitet. Optional können Sie ein Request-Mapping für die Flow-Variable hinterlegen.

Webhook Flow Trigger Konfiguration

Datastore

Das “Datastore-Import” Ziel ermöglicht es, die Daten einer Webhook-Anfrage als Zeile in einem Datastore zu speichern. Wählen Sie zunächst einen Datastore aus, in dem die Daten gespeichert werden sollen. Außerdem können ein Folder und ein Verarbeitungsstatus für die Datensätze ausgewählt werden. Wenn kein Folder ausgewählt ist, werden die Datensätze in den “default” Folder importiert. Optional können Sie ein Request-Mapping für die Datastore-Schema Spalten hinterlegen.

Webhook Datastore Konfiguration

Webhook URL im externen System hinterlegen

Sobald der Webhook fertig konfiguriert ist, kann die URL in Ihrem externen System hinterlegt werden. Vergessen Sie nicht den Personal Access Token (PAT) im Header oder als URL-Parameter anzugeben.

Webhook URL am Beispiel von shopify: Webhook URL im ext. System hinterlegen

Webhook-Anfragen

Auf der Übersichtsseite finden Sie pro Webhook einen Link zur Ansicht der Webhook-Anfragen. Eine Webhook-Anfrage entspricht einem Aufruf der Webhook-URL. Webhook-Anfragen anzeigen

In der Tabelle finden Sie einige Details zum Aufruf:

Webhook-Anfragen

Erstellt am: Erstellungsdatum/-zeit der Anfrage
Status: Status der Verarbeitung der Anfrage. Mögliche Werte sind:
- Neu – Anfrage eingegangen, aber noch nicht verarbeitet
- Erfolgreich – Die Anfrage wurde erfolgreich an das Ziel weitergegeben. Achtung: Der Status bezieht sich nur auf die Weitergabe der Webhook-Anfrage an das konfigurierte Ziel. Die Ausführung eines Flows kann beispielsweise trotzdem mit einem Fehler beendet werden.
- Fehler – Bei der Verarbeitung der Webhook-Anfrage ist ein Fehler aufgetreten. Dies kann z.B. passieren, wenn der Benutzer keinen Zugriff auf das konfigurierte Ziel hat oder es nicht mehr existiert (z.B. Datastore oder Flow wurden entfernt). In der Spalte “Antwort” finden Sie in diesem Fall eine Fehlermeldung.
Traffic: Verbrauchter Traffic der Webhook-Anfrage
Antwort: Die Statusnachricht
Parameter: Die (URL-) Parameter der Webhook-Anfrage
Header: Die HTTP-Header der Webhook-Anfrage
Anfrage-Body: Der Request Body der Webhook-Anfrage
Verarbeitungsziel: Ein Link zum Ziel der Verarbeitung (Flow -> Eventlog des Runs, Datastore -> zum Datastore)