Zum Hauptinhalt springen

🌐 Webhook-Trigger

Der Webhook-Trigger ermöglicht es externen Systemen, Workflows in SmartFlow durch das Senden von Daten über API-Anfragen zu initiieren. Dieser Trigger ist ideal für die Integration von SmartFlow mit Drittanwendungen und ermöglicht eine dynamische und nahtlose Automatisierung von Aufgaben.

📝 Trigger-Details​

Name: Webhook
Kategorie: Trigger

🔧 Parameter​

1. Webhook-URL​

  • Typ: string
  • Beschreibung: Die Endpunkt-URL für den Webhook, um eingehende Anfragen zu empfangen. Diese wird automatisch für jeden Workflow, der diesen Trigger verwendet, generiert.
  • Erforderlich: Ja
  • Beispiel: 
    https://api.smartflow.com/webhooks/{workflowId}

2. Payload​

  • Typ: object
  • Beschreibung: Die Daten, die vom externen System im Anfragekörper gesendet werden. Dieser Payload kann benutzerdefinierte Felder enthalten, abhängig von der Integration.
  • Erforderlich: Ja
  • Beispiel: 
    {
      "event": "order_created",
      "orderId": "12345",
      "customer": {
        "name": "John Doe",
        "email": "john@example.com"
      }
    }

3. Header​

  • Typ: object
  • Beschreibung: Optionale Header, die das externe System möglicherweise für Authentifizierungs- oder Metadatenzwecke einfügt.
  • Erforderlich: Nein
  • Beispiel: 
    {
      "Authorization": "Bearer your-api-key",
      "Content-Type": "application/json"
    }

🚀 So funktioniert es​

  1. Webhook-URL-Konfiguration:

    • Beim Erstellen eines Workflows mit einem Webhook-Trigger generiert SmartFlow eine eindeutige URL für den Webhook.
    • Teilen Sie diese URL mit dem externen System, um deren Integration zu konfigurieren.

  2. API-Schlüsselabruf:

    • Navigieren Sie zu ChatModel-Einstellungen.
    • Gehen Sie zu Integration → Web.
    • Klicken Sie auf API-Schlüssel kopieren, um das erforderliche Authentifizierungstoken abzurufen.

  3. Payload-Struktur:

    • Externe Systeme senden Daten (Payload) an die Webhook-URL über eine HTTP POST-Anfrage.
    • Der Payload muss der Struktur entsprechen, die vom Workflow gefordert wird.

  4. Trigger-Ausführung:

    • Wenn der Webhook eine gültige Anfrage erhält, wird der zugehörige Workflow automatisch ausgelöst.
    • SmartFlow verarbeitet den Payload, führt definierte Aktionen aus und gibt eine Antwort zurück, falls erforderlich.

💡 Anwendungsfälle​

  1. CRM-Integration:

    • Szenario: Ein Kunde erstellt ein neues Konto in Ihrem CRM-System.
    • Webhook: Das CRM sendet eine POST-Anfrage an SmartFlow mit den Kundendaten.
    • Workflow: Sendet eine Willkommens-E-Mail und fügt den Kunden Ihrer Marketingliste hinzu.

  2. Bestellmanagement:

    • Szenario: Eine E-Commerce-Plattform verarbeitet eine neue Bestellung.
    • Webhook: Die Plattform sendet Bestelldetails an SmartFlow.
    • Workflow: Aktualisiert den Bestand, sendet eine Bestellbestätigungs-E-Mail und benachrichtigt das Lager.

  3. Vorfallüberwachung:

    • Szenario: Ein Überwachungssystem erkennt einen kritischen Fehler.
    • Webhook: Das System sendet einen Alarm an SmartFlow.
    • Workflow: Erstellt einen Vorfallbericht und benachrichtigt das Ingenieurteam.

🔍 Beispielkonfiguration​

Eingehende Webhook-Anfrage​

URL:

https://api.smartflow.com/webhooks/abc123

Payload:

{
  "event": "user_registered",
  "userId": "67890",
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Header:

{
  "Authorization": "Bearer 123456789",
  "Content-Type": "application/json"
}

🛠️ Best Practices​

  1. Validierung:

    • Validieren Sie eingehende Anfragen, um die Datenintegrität zu gewährleisten und Missbrauch zu verhindern.
    • Verwenden Sie sichere Header oder Tokens zur Authentifizierung.

  2. API-Schlüssel-Sicherheit:

    • Stellen Sie sicher, dass der API-Schlüssel, der aus ChatModel-Einstellungen → Integration → Web abgerufen wird, sicher aufbewahrt und nicht öffentlich zugänglich gemacht wird.

  3. Datenzuordnung:

    • Ordnen Sie eingehende Felder klar den Workflow-Variablen zu, um eine nahtlose Verarbeitung zu gewährleisten.

  4. Testen:

    • Testen Sie den Webhook mit Beispiel-Payloads, um die Kompatibilität und Zuverlässigkeit sicherzustellen.

  5. Fehlerbehandlung:

    • Konfigurieren Sie Workflows, um fehlende oder fehlerhafte Daten elegant zu behandeln.

📊 Überwachung und Debugging​

  • Aktivitätsprotokolle:
    Verfolgen Sie eingehende Webhook-Anfragen und deren Verarbeitungsstatus im Dashboard von SmartFlow.

  • Fehlerberichterstattung:
    Identifizieren Sie fehlgeschlagene Anfragen und sehen Sie sich die Fehlermeldungen zur Fehlersuche an.

Dieser Abschnitt bietet eine detaillierte Anleitung für den Webhook-Trigger und stellt sicher, dass Benutzer ihn nahtlos in ihre Workflows integrieren können. Lassen Sie mich wissen, ob Sie weitere Anpassungen benötigen!