🌐 Webhook Trigger

Webhook Trigger umožňuje externým systémom iniciovať pracovné toky v SmartFlow zasielaním údajov prostredníctvom API požiadaviek. Tento spúšťač je ideálny na integráciu SmartFlow s aplikáciami tretích strán, čo umožňuje dynamickú a bezproblémovú automatizáciu úloh.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Koncový bod URL pre webhook na prijímanie prichádzajúcich požiadaviek. Tento URL je automaticky generovaný pre každý pracovný tok, ktorý používa tento spúšťač.
• Required: Áno
• Example:

  https://api.smartflow.com/webhooks/{workflowId}

2. Payload

• Type: object
• Description: Údaje zaslané externým systémom v tele požiadavky. Tento payload môže obsahovať vlastné polia v závislosti od integrácie.
• Required: Áno
• Example:

  {
    "event": "order_created",
    "orderId": "12345",
    "customer": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }

3. Headers

• Type: object
• Description: Voliteľné hlavičky, ktoré môže externý systém zahrnúť na účely autentifikácie alebo metadát.
• Required: Nie
• Example:

  {
    "Authorization": "Bearer your-api-key",
    "Content-Type": "application/json"
  }

---

🚀 How It Works

1. Webhook URL Configuration:

   • Pri vytváraní pracovného toku s Webhook Trigger SmartFlow generuje jedinečný URL pre webhook.
   • Zdieľajte tento URL s externým systémom na konfiguráciu ich integrácie.

2. API Key Retrieval:

   • Prejdite do ChatModel Settings.
   • Choďte do Integration → Web.
   • Kliknite na Copy API Key na získanie potrebného autentifikačného tokenu.

3. Payload Structure:

   • Externé systémy zasielajú údaje (payload) na webhook URL pomocou HTTP POST požiadavky.
   • Payload musí zodpovedať štruktúre požadovanej pracovným tokom.

4. Trigger Execution:

   • Keď webhook prijme platnú požiadavku, priradený pracovný tok sa automaticky spustí.
   • SmartFlow spracováva payload, vykonáva definované akcie a v prípade potreby vracia odpoveď.

---

💡 Použitie

1. Integrácia CRM:

   • Scenár: Zákazník vytvorí nový účet vo vašom CRM systéme.
   • Webhook: CRM posiela POST požiadavku do SmartFlow s údajmi o zákazníkovi.
   • Pracovný tok: Posiela uvítací e-mail a pridáva zákazníka do vášho marketingového zoznamu.

2. Správa objednávok:

   • Scenár: E-commerce platforma spracováva novú objednávku.
   • Webhook: Platforma posiela podrobnosti objednávky do SmartFlow.
   • Pracovný tok: Aktualizuje zásoby, posiela e-mail s potvrdením objednávky a informuje sklad.

3. Monitorovanie incidentov:

   • Scenár: Monitorovací systém zistí kritickú chybu.
   • Webhook: Systém posiela upozornenie do SmartFlow.
   • Pracovný tok: Vytvára správu o incidente a informuje inžiniersky tím.

---

🔍 Príklad konfigurácie

Prichádzajúca požiadavka Webhook

URL:

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

Payload:

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

Hlavičky:

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

---

🛠️ Najlepšie praktiky

1. Validácia:

   • Validujte prichádzajúce požiadavky, aby ste zabezpečili integritu údajov a predišli zneužitiu.
   • Používajte zabezpečené hlavičky alebo tokeny na autentifikáciu.

2. Bezpečnosť API kľúča:

   • Zabezpečte, aby bol API kľúč získaný z Nastavenia ChatModel → Integrácia → Web uchovávaný v bezpečí a nebol verejne vystavený.

3. Mapovanie údajov:

   • Jasne mapujte prichádzajúce polia na premenné pracovného toku pre bezproblémové spracovanie.

4. Testovanie:

   • Testujte webhook s ukážkovými payloadmi, aby ste zabezpečili kompatibilitu a spoľahlivosť.

5. Správa chýb:

   • Nakonfigurujte pracovné toky tak, aby elegantne spracovávali chýbajúce alebo nesprávne údaje.

---

📊 Monitorovanie a ladenie

• Aktivity protokoly:
  Sledujte prichádzajúce požiadavky webhook a ich stav spracovania na paneli SmartFlow.

• Hlásenie chýb:
  Identifikujte zlyhané požiadavky a zobrazte podrobnosti o chybách na riešenie problémov.

---

Táto sekcia poskytuje podrobný sprievodca pre Webhook Trigger, zabezpečujúc, že používatelia ho môžu bezproblémovo integrovať do svojich pracovných tokov. Dajte mi vedieť, ak potrebujete nejaké úpravy!