Webhook-Knoten#
Verwenden Sie den Webhook-Knoten, um Webhooks zu erstellen, die Daten von Apps und Diensten empfangen können, wenn ein Ereignis eintritt. Er ist ein Trigger-Knoten, was bedeutet, dass er einen Localmind Automate-Workflow starten kann. Dies ermöglicht es Diensten, sich mit Localmind Automate zu verbinden und einen Workflow auszuführen.
Sie können den Webhook-Knoten als Auslöser für einen Workflow verwenden, wenn Sie Daten empfangen und einen Workflow basierend auf den Daten ausführen möchten. Der Webhook-Knoten unterstützt auch die Rückgabe der am Ende eines Workflows generierten Daten. Dies macht ihn nützlich, um einen Workflow zu erstellen, der Daten verarbeitet und die Ergebnisse zurückgibt, wie ein API-Endpunkt.
Der Webhook ermöglicht es Ihnen, Workflows von Diensten auszulösen, die keinen dedizierten App-Trigger-Knoten haben.
Workflow-Entwicklungsprozess#
Localmind Automate bietet verschiedene Webhook-URLs für Tests und Produktion. Die Test-URL enthält eine Option zum Auf Test-Event warten. Weitere Informationen zum Erstellen, Testen und Verschieben Ihres Webhook-Knotens in die Produktion finden Sie unter Workflow-Entwicklung.
Knotenparameter#
Verwenden Sie diese Parameter, um Ihren Knoten zu konfigurieren.
Webhook-URLs#
Der Webhook-Knoten hat zwei Webhook-URLs: Test und Produktion. Localmind Automate zeigt die URLs oben im Knotenbereich an.
Wählen Sie Test-URL oder Produktions-URL, um umzuschalten, welche URL Localmind Automate anzeigt.
- Test: Localmind Automate registriert einen Test-Webhook, wenn Sie Auf Test-Event warten oder Workflow testen auswählen, falls der Workflow nicht aktiv ist. Wenn Sie die Webhook-URL aufrufen, zeigt Localmind Automate die Daten im Workflow an.
- Produktion: Localmind Automate registriert einen Produktions-Webhook, wenn Sie den Workflow aktivieren. Bei Verwendung der Produktions-URL zeigt Localmind Automate die Daten nicht im Workflow an. Sie können die Workflow-Daten für eine Produktionsausführung weiterhin anzeigen: Wählen Sie den Tab Ausführungen im Workflow und wählen Sie dann die Workflow-Ausführung aus, die Sie anzeigen möchten.
HTTP-Methode#
Der Webhook-Knoten unterstützt Standard-HTTP-Request-Methoden:
- DELETE
- GET
- HEAD
- PATCH
- POST
-
PUT
Webhook max. Nutzlast
Die maximale Webhook-Nutzlastgröße beträgt 16 MB.
Pfad#
Standardmäßig enthält dieses Feld einen zufällig generierten Webhook-URL-Pfad, um Konflikte mit anderen Webhook-Knoten zu vermeiden.
Sie können manuell einen URL-Pfad angeben, einschließlich des Hinzufügens von Routenparametern. Sie müssen dies beispielsweise tun, wenn Sie Localmind Automate verwenden, um ein API zu prototypisieren und konsistente Endpunkt-URLs wünschen.
Das Feld Pfad kann die folgenden Formate haben:
/:variable
/path/:variable
/:variable/path
/:variable1/path/:variable2
/:variable1/:variable2
Unterstützte Authentifizierungsmethoden#
Sie können eine Authentifizierung für jeden Dienst anfordern, der Ihre Webhook-URL aufruft. Wählen Sie aus diesen Authentifizierungsmethoden:
- Basic Auth
- Header Auth
- JWT Auth
- Keine
Weitere Informationen zum Einrichten der einzelnen Anmeldeinformationstypen finden Sie unter Webhook-Anmeldeinformationen.
Antworten#
- Sofort: Der Webhook-Knoten gibt den Antwortcode und die Meldung Workflow wurde gestartet zurück.
- Wenn Letzter Knoten fertig ist: Der Webhook-Knoten gibt den Antwortcode und die Datenausgabe des letzten im Workflow ausgeführten Knotens zurück.
- Verwenden des Knotens 'Auf Webhook antworten': Der Webhook-Knoten antwortet wie im Knoten Auf Webhook antworten definiert.
Antwortcode#
Passen Sie den HTTP-Antwortcode an, den der Webhook-Knoten bei erfolgreicher Ausführung zurückgibt. Wählen Sie aus gängigen Antwortcodes oder erstellen Sie einen benutzerdefinierten Code.
Antwortdaten#
Wählen Sie aus, welche Daten in den Antworttext aufgenommen werden sollen:
- Alle Einträge: Der Webhook gibt alle Einträge des letzten Knotens in einem Array zurück.
- Erster Eintrag JSON: Der Webhook gibt die JSON-Daten des ersten Eintrags des letzten Knotens in einem JSON-Objekt zurück.
- Erster Eintrag Binär: Der Webhook gibt die binären Daten des ersten Eintrags des letzten Knotens in einer binären Datei zurück.
- Kein Antworttext: Der Webhook gibt ohne Text zurück.
Gilt nur für Antworten > Wenn Letzter Knoten fertig ist.
Knotenoptionen#
Wählen Sie Option hinzufügen, um weitere Konfigurationsoptionen anzuzeigen. Die verfügbaren Optionen hängen von Ihren Knotenparametern ab. Informationen zur Optionsverfügbarkeit finden Sie in der Tabelle.
- Zulässige Ursprünge (CORS): Legen Sie die zulässigen Cross-Origin-Domänen fest. Geben Sie eine kommagetrennte Liste von URLs ein, die für Cross-Origin-Nicht-Preflight-Anforderungen zulässig sind. Verwenden Sie
*
(Standard), um alle Ursprünge zuzulassen. - Binäre Eigenschaft: Wenn Sie diese Einstellung aktivieren, kann der Webhook-Knoten binäre Daten empfangen, z. B. ein Bild oder eine Audiodatei. Geben Sie den Namen der binären Eigenschaft ein, in die die Daten der empfangenen Datei geschrieben werden sollen.
- Bots ignorieren: Ignorieren Sie Anfragen von Bots wie Link-Previewern und Web-Crawlern.
- IP(s)-Whitelist: Aktivieren Sie diese Option, um einzuschränken, wer (oder was) eine Webhook-Trigger-URL aufrufen kann. Geben Sie eine kommagetrennte Liste zulässiger IP-Adressen ein. Der Zugriff von IPs außerhalb der Whitelist löst einen 403-Fehler aus. Wenn dies leer gelassen wird, können alle IP-Adressen die Webhook-Trigger-URL aufrufen.
- Kein Antworttext: Aktivieren Sie diese Option, um zu verhindern, dass Localmind Automate einen Text mit der Antwort sendet.
- Raw Body: Geben Sie an, dass der Webhook-Knoten Daten in einem Rohformat empfängt, z. B. JSON oder XML.
- Response Content-Type: Wählen Sie das Format für den Webhook-Text aus.
- Antwortdaten: Senden Sie benutzerdefinierte Daten mit der Antwort.
- Antwortheader: Senden Sie zusätzliche Header in der Webhook-Antwort. Weitere Informationen zu Antwortheadern finden Sie unter MDN Web Docs | Response header.
- Eigenschaftsname: Standardmäßig gibt Localmind Automate alle verfügbaren Daten zurück. Sie können auswählen, dass ein bestimmter JSON-Schlüssel zurückgegeben wird, sodass Localmind Automate den Wert zurückgibt.
Option | Erforderliche Knoteneinstellungen |
---|---|
Zulässige Ursprünge (CORS) | Beliebig |
Binäre Eigenschaft | Entweder: HTTP-Methode > POST HTTP-Methode > PATCH HTTP-Methode > PUT |
Bots ignorieren | Beliebig |
IP(s)-Whitelist | Beliebig |
Eigenschaftsname | Beide: Antworten > Wenn Letzter Knoten fertig ist Antwortdaten > Erster Eintrag JSON |
Kein Antworttext | Antworten > Sofort |
Raw Body | Beliebig |
Antwortcode | Beliebig außer Antworten > Verwenden des Knotens 'Auf Webhook antworten' |
Response Content-Type | Beide: Antworten > Wenn Letzter Knoten fertig ist Antwortdaten > Erster Eintrag JSON |
Antwortdaten | Antworten > Sofort |
Antwortheader | Beliebig |
Häufige Probleme#
Informationen zu häufigen Fragen oder Problemen und Lösungsvorschlägen finden Sie unter Häufige Probleme.