🌐 Webhook Trigger

A Webhook Trigger lehetővé teszi külső rendszerek számára, hogy API kérések küldésével elindítsák a munkafolyamatokat a SmartFlow-ban. Ez a trigger ideális a SmartFlow harmadik féltől származó alkalmazásokkal való integrálásához, lehetővé téve a feladatok dinamikus és zökkenőmentes automatizálását.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: A webhook végpont URL-je, amely fogadja a bejövő kéréseket. Ez automatikusan generálódik minden munkafolyamat számára, amely ezt a triggert használja.
• Required: Igen
• Example:

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

2. Payload

• Type: object
• Description: Az a data, amelyet a külső rendszer küld a kérés törzsében. Ez a payload tartalmazhat egyedi mezőket az integrációtól függően.
• Required: Igen
• Example:

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

3. Headers

• Type: object
• Description: Opcionális fejléc, amelyet a külső rendszer tartalmazhat az azonosítás vagy a metaadatok céljából.
• Required: Nem
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Amikor egy munkafolyamatot hoz létre Webhook Trigger-rel, a SmartFlow egyedi URL-t generál a webhook számára.
   • Ossza meg ezt az URL-t a külső rendszerrel az integrációjuk konfigurálásához.

2. API Key Retrieval:

   • Navigáljon a ChatModel Settings-hez.
   • Menjen a Integration → Web menüpontra.
   • Kattintson a Copy API Key gombra a szükséges azonosító token megszerzéséhez.

3. Payload Structure:

   • A külső rendszerek HTTP POST kérést használva küldenek adatokat (payload) a webhook URL-re.
   • A payload-nak meg kell felelnie a munkafolyamat által megkövetelt struktúrának.

4. Trigger Execution:

   • Amikor a webhook érvényes kérést kap, a hozzá kapcsolódó munkafolyamat automatikusan elindul.
   • A SmartFlow feldolgozza a payload-ot, végrehajtja a meghatározott műveleteket, és szükség esetén választ ad.

---

💡 Használati Esetek

1. CRM Integráció:

   • Forgatókönyv: Egy ügyfél új fiókot hoz létre a CRM rendszerében.
   • Webhook: A CRM egy POST kérést küld a SmartFlow-nak az ügyfél adataival.
   • Munkafolyamat: Üdvözlő e-mailt küld és hozzáadja az ügyfelet a marketing listájához.

2. Rendeléskezelés:

   • Forgatókönyv: Egy e-kereskedelmi platform feldolgoz egy új rendelést.
   • Webhook: A platform elküldi a rendelési adatokat a SmartFlow-nak.
   • Munkafolyamat: Frissíti a készletet, rendelés visszaigazoló e-mailt küld, és értesíti a raktárat.

3. Incidens Figyelés:

   • Forgatókönyv: Egy figyelő rendszer kritikus hibát észlel.
   • Webhook: A rendszer riasztást küld a SmartFlow-nak.
   • Munkafolyamat: Incidens jelentést készít és értesíti a mérnöki csapatot.

---

🔍 Példa Konfiguráció

Bejövő Webhook Kérés

URL:

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

Payload:

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

Fejlécek:

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

---

🛠️ Legjobb Gyakorlatok

1. Validálás:

   • Érvényesítse a bejövő kéréseket az adatintegritás biztosítása és a visszaélések megelőzése érdekében.
   • Használjon biztonságos fejléceket vagy tokeneket az azonosításhoz.

2. API Kulcs Biztonság:

   • Gondoskodjon arról, hogy a ChatModel Beállítások → Integráció → Web menüből származó API kulcs biztonságban legyen, és ne legyen nyilvánosan hozzáférhető.

3. Adat Térképezés:

   • Világosan térképezze fel a bejövő mezőket a munkafolyamat változóira a zökkenőmentes feldolgozás érdekében.

4. Tesztelés:

   • Tesztelje a webhookot mint payload-okkal a kompatibilitás és megbízhatóság biztosítása érdekében.

5. Hiba Kezelés:

   • Konfigurálja a munkafolyamatokat, hogy elegánsan kezeljék a hiányzó vagy hibás adatokat.

---

📊 Figyelés és Hibakeresés

• Tevékenységi Naplók:
  Kövesse nyomon a bejövő webhook kéréseket és azok feldolgozási állapotát a SmartFlow irányítópultján.

• Hiba Jelentés:
  Azonosítsa a sikertelen kéréseket és nézze meg a hiba részleteit a hibaelhárításhoz.

---

Ez a szakasz részletes útmutatót nyújt a Webhook Triggerhez, biztosítva, hogy a felhasználók zökkenőmentesen integrálhassák azt a munkafolyamataikba. Kérem, jelezze, ha szüksége van bármilyen finomításra!