🌐 Webhook Trigger

Webhook Trigger umožňuje externím systémům iniciovat pracovní postupy v SmartFlow zasíláním dat prostřednictvím API požadavků. Tento trigger je ideální pro integraci SmartFlow s aplikacemi třetích stran, což umožňuje dynamickou a bezproblémovou automatizaci úkolů.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Koncový bod URL pro webhook, který přijímá příchozí požadavky. Tento URL je automaticky generován pro každý pracovní postup používající tento trigger.
• Required: Ano
• Example:

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

2. Payload

• Type: object
• Description: Data zaslaná externím systémem v těle požadavku. Tento payload může zahrnovat vlastní pole v závislosti na integraci.
• Required: Ano
• Example:

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

3. Headers

• Type: object
• Description: Volitelné hlavičky, které může externí systém zahrnout pro účely autentizace nebo metadat.
• Required: Ne
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Při vytváření pracovního postupu s Webhook Trigger SmartFlow generuje jedinečné URL pro webhook.
   • Sdílejte toto URL s externím systémem pro konfiguraci jejich integrace.

2. API Key Retrieval:

   • Přejděte do ChatModel Settings.
   • Jděte na Integration → Web.
   • Klikněte na Copy API Key pro získání potřebného autentizačního tokenu.

3. Payload Structure:

   • Externí systémy zasílají data (payload) na URL webhooku pomocí HTTP POST požadavku.
   • Payload musí odpovídat struktuře požadované pracovním postupem.

4. Trigger Execution:

   • Když webhook obdrží platný požadavek, příslušný pracovní postup je automaticky spuštěn.
   • SmartFlow zpracovává payload, vykonává definované akce a vrací odpověď, pokud je to nutné.

---

💡 Případové studie

1. Integrace CRM:

   • Scénář: Zákazník vytvoří nový účet ve vašem CRM systému.
   • Webhook: CRM odešle POST požadavek na SmartFlow s detaily zákazníka.
   • Workflow: Odešle uvítací e-mail a přidá zákazníka do vašeho marketingového seznamu.

2. Správa objednávek:

   • Scénář: E-commerce platforma zpracovává novou objednávku.
   • Webhook: Platforma odešle detaily objednávky na SmartFlow.
   • Workflow: Aktualizuje inventář, odešle potvrzení objednávky e-mailem a informuje sklad.

3. Monitorování incidentů:

   • Scénář: Monitorovací systém detekuje kritickou chybu.
   • Webhook: Systém odešle upozornění na SmartFlow.
   • Workflow: Vytvoří zprávu o incidentu a informuje inženýrský tým.

---

🔍 Příklad konfigurace

Příchozí požadavek Webhook

URL:

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

Payload:

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

Headers:

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

---

🛠️ Nejlepší praktiky

1. Validace:

   • Validujte příchozí požadavky, abyste zajistili integritu dat a předešli zneužití.
   • Používejte zabezpečené hlavičky nebo tokeny pro autentizaci.

2. Bezpečnost API klíče:

   • Zajistěte, aby byl API klíč získaný z Nastavení ChatModel → Integrace → Web uchováván v bezpečí a nebyl veřejně vystaven.

3. Mapování dat:

   • Jasně mapujte příchozí pole na proměnné workflow pro bezproblémové zpracování.

4. Testování:

   • Testujte webhook s ukázkovými payloady, abyste zajistili kompatibilitu a spolehlivost.

5. Zpracování chyb:

   • Nakonfigurujte workflow tak, aby elegantně zpracovávalo chybějící nebo nesprávně formátovaná data.

---

📊 Monitorování a ladění

• Aktivní protokoly:
  Sledování příchozích požadavků webhook a jejich stav zpracování na panelu SmartFlow.

• Hlášení chyb:
  Identifikujte neúspěšné požadavky a zobrazte detaily chyb pro odstraňování problémů.

---

Tato sekce poskytuje podrobný návod pro Webhook Trigger, což zajišťuje, že uživatelé jej mohou bezproblémově integrovat do svých workflow. Dejte mi vědět, pokud potřebujete nějaké úpravy!