Webhook-Knoten verwenden

Webhook-Knoten verwenden

Mit dem Webhook-Knoten kannst Du externe Systeme oder APIs direkt aus einem melibo Workflow ansprechen.

Der Knoten sendet eine HTTP-Anfrage an eine externe URL und verarbeitet die Antwort anschließend im Workflow.

Typische Einsatzfälle sind:

• Daten aus externen APIs abrufen

• Tickets oder Daten in anderen Systemen aktualisieren

• Bestellungen oder Kundeninformationen abfragen

• Integrationen mit Tools wie Zendesk, Shopify oder internen APIs

---

Funktionsweise

Der Webhook-Knoten sendet eine HTTP-Anfrage an eine definierte URL.

Dabei können folgende Elemente konfiguriert werden:

• HTTP-Methode

• API-URL

• Request Header

• Request Body

• Return Variable

Die Antwort der API wird anschließend im Workflow gespeichert und kann in weiteren Knoten verwendet werden.

---

HTTP-Methode

Der Webhook unterstützt verschiedene HTTP-Methoden.

Mögliche Optionen sind:

• GET – Daten abrufen

• POST – Daten senden oder erstellen

• PUT – Daten aktualisieren

• PATCH – Teilweise Updates durchführen

• DELETE – Daten löschen

Welche Methode verwendet wird, hängt von der jeweiligen API ab.

---

Webhook URL

Hier wird die Ziel-URL der API eingetragen.

Beispiel:

https://api.example.com/orders

Die URL kann auch Variablen enthalten, um dynamische Werte zu übergeben.

Beispiel:

https://example.zendesk.com/api/v2/tickets/@var{ticketID}.json

Dabei wird die Variable automatisch durch den aktuellen Wert ersetzt.

---

Request Header

Im Bereich Request Header können zusätzliche Header für die API-Anfrage definiert werden.

Typische Beispiele sind:

• Authorization

• API Keys

• Content Type

• Kundenspezifische Header

Beispiel:

Key

Authorization

Value

Bearer @var{access_token}

Beispiel für kundenspezifische Header:

Key

x-api-customer

Value

example_customer

Variablen können auch hier verwendet werden.

---

Request Body

Wenn die API Daten benötigt, können diese im Request Body übergeben werden.

Der Body wird meist im JSON-Format geschrieben.

Beispiel:

{
  "ticket": {
    "custom_fields": [
      {
        "id": 31393965329042,
        "value": "@var{taStatus}"
      }
    ]
  }
}

Variablen können auch im JSON verwendet werden.

Beispiel:

@var{ticketID}
@var{orderId}
@var{selected_car_id}

Diese werden beim Ausführen des Workflows automatisch ersetzt.

---

Beispiel: API Anfrage mit Variablen

Beispiel für eine GraphQL-API Anfrage:

{
  "operationName": "getType",
  "variables": {
    "id": "@var{selected_car_id}",
    "language": "de"
  },
  "query": "query getType($id: Int!, $language: String!) { type(id: $id, language: $language) }"
}

Hier wird die Variable selected_car_id dynamisch an die API übergeben.

---

Return Variable

Die Return Variable speichert die Antwort der API.

Beispiel:

api_response

Die API-Antwort kann anschließend im Workflow weiterverwendet werden.

Zum Beispiel:

• in einem Code-Knoten

• in einem Mail-Generator

• in Bedingungen (If-Knoten)

---

Erfolgreiche Anfrage

Wenn die API-Anfrage erfolgreich war, wird der Workflow über den Pfad Erfolgreich fortgesetzt.

Hier können zum Beispiel folgende Schritte erfolgen:

• Antwort auswerten

• Daten weiterverarbeiten

• Nachricht generieren

---

Fehler bei der Anfrage

Wenn die Anfrage fehlschlägt, wird der Workflow über den Pfad Fehler weitergeführt.

Typische Gründe für Fehler sind:

• falsche API-URL

• ungültige Authentifizierung

• falsche Request-Parameter

• API nicht erreichbar

Über diesen Pfad kann z. B. eine alternative Logik gestartet werden.

---

Beispiel: Zendesk Ticket aktualisieren

Der Webhook kann verwendet werden, um ein Zendesk-Ticket zu aktualisieren.

Methode

PUT

URL

https://example.zendesk.com/api/v2/tickets/@var{ticketID}.json

Request Header

Authorization: @var{secrets.Authorization}

Request Body

{
  "ticket": {
    "custom_fields": [
      {
        "id": 31393965329042,
        "value": "@var{taStatus}"
      }
    ]
  }
}

Damit wird ein bestimmtes Custom Field im Ticket aktualisiert.

---

Nutzung der API Antwort

Die Antwort der API wird in der Return Variable gespeichert.

Beispiel:

api_response

Diese Daten können anschließend in weiteren Knoten verarbeitet werden.

Zum Beispiel in einem Code-Knoten:

• Daten auslesen

• Status prüfen

• Entscheidungen im Workflow treffen

---

Best Practices

Variablen verwenden

Nutze Variablen, um dynamische Daten an APIs zu übergeben.

Beispiele:

@var{ticketID}
@var{orderId}
@var{selected_car_id}

---

Secrets für Tokens verwenden

API-Tokens sollten nicht direkt im Workflow stehen.

Stattdessen empfiehlt es sich, sie über Secrets zu verwalten.

Beispiel:

@var{secrets.Authorization}

---

Fehlerpfad definieren

Definiere immer eine Logik für den Fehler-Pfad, damit Workflows nicht unerwartet abbrechen.

---

API-Antwort prüfen

Wenn die API-Antwort im Workflow benötigt wird, sollte sie anschließend über einen Code-Knoten ausgewertet werden.

---

Häufige Fehler

Falsche HTTP-Methode

Viele APIs erwarten eine bestimmte Methode (GET, POST, PUT).

---

Fehlende Authentifizierung

Viele APIs benötigen einen Authorization-Header oder API-Key.

---

Ungültiges JSON

Der Request Body muss korrektes JSON sein.

---

Fehlende Variablen

Wenn eine verwendete Variable keinen Wert hat, kann die Anfrage fehlschlagen.