🌐 Webhook Trigger

Webhook Trigger leidžia išorinėms sistemoms inicijuoti darbo eigas SmartFlow siunčiant duomenis per API užklausas. Šis triggeris idealiai tinka integruoti SmartFlow su trečiųjų šalių programomis, leidžiant dinamiškai ir sklandžiai automatizuoti užduotis.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Webhook galinis URL, skirtas gauti atvykstančias užklausas. Šis URL automatiškai sugeneruojamas kiekvienai darbo eigai, naudojančiai šį triggerį.
• Required: Taip
• Example:

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

2. Payload

• Type: object
• Description: Duomenys, siunčiami išorinės sistemos užklausos kūne. Šis payload gali apimti pasirinktinius laukus, priklausomai nuo integracijos.
• Required: Taip
• Example:

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

3. Headers

• Type: object
• Description: Pasirinktiniai antraštės, kurias išorinė sistema gali įtraukti autentifikacijai arba metaduomenų tikslais.
• Required: Ne
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Kuriant darbo eigą su Webhook Trigger, SmartFlow sugeneruoja unikalų URL webhookui.
   • Pasidalykite šiuo URL su išorine sistema, kad sukonfigūruotumėte jų integraciją.

2. API Key Retrieval:

   • Eikite į ChatModel Settings.
   • Pasirinkite Integration → Web.
   • Paspauskite Copy API Key, kad gautumėte reikiamą autentifikacijos raktą.

3. Payload Structure:

   • Išorinės sistemos siunčia duomenis (payload) į webhook URL naudodamos HTTP POST užklausą.
   • Payload turi atitikti darbo eigai reikiamą struktūrą.

4. Trigger Execution:

   • Kai webhook gauna galiojančią užklausą, susijusi darbo eiga automatiškai inicijuojama.
   • SmartFlow apdoroja payload, vykdo apibrėžtas veiklas ir grąžina atsakymą, jei reikia.

---

💡 Naudojimo atvejai

1. CRM integracija:

   • Scenarijus: Klientas sukuria naują paskyrą jūsų CRM sistemoje.
   • Webhook: CRM siunčia POST užklausą į SmartFlow su kliento duomenimis.
   • Darbo eiga: Išsiunčia sveikinimo el. laišką ir prideda klientą prie jūsų rinkodaros sąrašo.

2. Užsakymų valdymas:

   • Scenarijus: E. prekybos platforma apdoroja naują užsakymą.
   • Webhook: Platforma siunčia užsakymo duomenis į SmartFlow.
   • Darbo eiga: Atnaujina inventorių, siunčia užsakymo patvirtinimo el. laišką ir praneša sandėliui.

3. Incidentų stebėjimas:

   • Scenarijus: Stebėjimo sistema nustato kritinę klaidą.
   • Webhook: Sistema siunčia pranešimą į SmartFlow.
   • Darbo eiga: Sukuria incidento ataskaitą ir praneša inžinierių komandai.

---

🔍 Pavyzdinė konfigūracija

Atvykstanti Webhook užklausa

URL:

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

Krovinių turinys:

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

Antraštės:

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

---

🛠️ Geriausios praktikos

1. Validacija:

   • Patikrinkite atvykstančias užklausas, kad užtikrintumėte duomenų vientisumą ir užkirstumėte kelią piktnaudžiavimui.
   • Naudokite saugias antraštes arba žetonus autentifikacijai.

2. API raktų saugumas:

   • Užtikrinkite, kad API raktas, gautas iš ChatModel Settings → Integration → Web, būtų saugomas ir neatskleistas viešai.

3. Duomenų žemėlapis:

   • Aiškiai susiekite atvykstančius laukus su darbo eigos kintamaisiais, kad procesas vyktų sklandžiai.

4. Testavimas:

   • Išbandykite webhook su pavyzdiniais krovinių turiniais, kad užtikrintumėte suderinamumą ir patikimumą.

5. Klaidos tvarkymas:

   • Konfigūruokite darbo eigas, kad jos tvarkytų trūkstamus ar netinkamus duomenis.

---

📊 Stebėjimas ir derinimas

• Veiklos žurnalai:
  Sekite atvykstančias webhook užklausas ir jų apdorojimo būseną SmartFlow skydelyje.

• Klaidų ataskaitos:
  Nustatykite nepavykusias užklausas ir peržiūrėkite klaidų detales, kad galėtumėte spręsti problemas.

---

Ši dalis pateikia išsamią instrukciją apie Webhook Trigger, užtikrinant, kad vartotojai galėtų ją sklandžiai integruoti į savo darbo eigas. Praneškite, jei reikia kokių nors patobulinimų!