🌐 Webhook Trigger

Il-Webhook Trigger jippermetti lis-sistemi esterni biex jibdew flussi ta' xogħol fil-SmartFlow billi jibagħtu data permezz ta' talbiet API. Dan it-trigger huwa ideali għall-integrazzjoni ta' SmartFlow ma' applikazzjonijiet ta' partijiet terzi, li jippermettu awtomazzjoni dinamika u bla xkiel tal-kompiti.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: L-URL tal-endpoint għall-webhook biex tirċievi t-talbiet li jaslu. Dan jiġi ġenerat awtomatikament għal kull fluss ta' xogħol li juża dan it-trigger.
• Required: Iva
• Example:

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

2. Payload

• Type: object
• Description: Id-data mibgħuta mis-sistema esterna fil-ġisem tat-talba. Din il-payload tista' tinkludi kampijiet custom skont l-integrazzjoni.
• Required: Iva
• Example:

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

3. Headers

• Type: object
• Description: Headers fakultattivi li s-sistema esterna tista' tinkludi għall-awtentikazzjoni jew għal skopijiet ta' metadata.
• Required: Le
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Meta toħloq fluss ta' xogħol b'Webhook Trigger, SmartFlow jiġġenera URL uniku għall-webhook.
   • Aqsam dan l-URL mas-sistema esterna biex tikkonfigura l-integrazzjoni tagħhom.

2. API Key Retrieval:

   • Naviga lejn ChatModel Settings.
   • Mur għal Integration → Web.
   • Ikklikkja Copy API Key biex tirriġistra t-token ta' awtentikazzjoni meħtieġ.

3. Payload Structure:

   • Is-sistemi esterni jibagħtu data (payload) lill-URL tal-webhook billi jużaw talba HTTP POST.
   • Il-payload għandu jaqbel mal-struttura meħtieġa mill-fluss ta' xogħol.

4. Trigger Execution:

   • Meta l-webhook jirċievi talba valida, il-fluss ta' xogħol assoċjat jiġi attivat awtomatikament.
   • SmartFlow jipproċessa l-payload, iwettaq l-azzjonijiet definiti, u jirritorna risposta jekk meħtieġ.

---

💡 Użu ta' Każijiet

1. Integrazjoni tal-CRM:

   • Xenarju: Klijent joħloq kont ġdid fis-sistema tal-CRM tiegħek.
   • Webhook: Il-CRM jibgħat talba POST lil SmartFlow bil-details tal-klijent.
   • Fluss ta' xogħol: Jibgħat email ta' merħba u jżid il-klijent mal-lista tal-marketing tiegħek.

2. Ġestjoni tal-Ordni:

   • Xenarju: Pjattaforma ta' e-commerce tipproċessa ordni ġdida.
   • Webhook: Il-pjattaforma tibgħat id-details tal-ordni lil SmartFlow.
   • Fluss ta' xogħol: Aġġorna l-inventarju, jibgħat email ta' konferma tal-ordni, u jinforma l-maħżen.

3. Monitoraġġ tal-Inċidenti:

   • Xenarju: Sistema ta' monitoraġġ tidentifika żball kritiku.
   • Webhook: Is-sistema tibgħat allerta lil SmartFlow.
   • Fluss ta' xogħol: Toħloq rapport ta' inċident u tinforma t-tim tal-inġinerija.

---

🔍 Eżempju ta' Konfigurazzjoni

Talba ta' Webhook Li Tgħaddi

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"
}

---

🛠️ Aħjar Prattiċi

1. Validazzjoni:

   • Ivalidaw it-talbiet li jidħlu biex jiżguraw l-integrità tad-data u jipprevjenu l-użu ħażin.
   • Uża headers jew tokens sikuri għall-awtorizzazzjoni.

2. Sigurtà tal-API Key:

   • Żgura li l-API key miġbura minn ChatModel Settings → Integration → Web tiġi żżomm sikura u ma tiġix esposta pubblikament.

3. Mappjar tad-Data:

   • Mappa b'mod ċar il-qasam li jidħol għall-variabbli tal-fluss ta' xogħol biex tiġi żgurata proċessar bla xkiel.

4. Testjar:

   • Ittestja l-webhook bil-payloads ta' eżempju biex tiżgura kompatibbiltà u affidabilità.

5. Ħidma tal-Iżbalji:

   • Ipprova l-flussi ta' xogħol biex jindirizzaw data nieqsa jew maħluqa ħażin b'mod eleganti.

---

📊 Monitoraġġ u Debugging

• Logs tal-Attività:
  Ikkontrolla t-talbiet ta' webhook li jidħlu u l-istatus tal-proċessar tagħhom fid-dashboard ta' SmartFlow.

• Rapporti ta' Iżbalji:
  Identifika t-talbiet li fallu u ara d-dettalji tal-iżbalji għall-iskop ta' troubleshooting.

---

Din is-sezzjoni tipprovdi gwida dettaljata għall-Webhooks Trigger, tiżgura li l-utenti jistgħu jintegrawha b'mod bla xkiel fil-flussi ta' xogħol tagħhom. Għidli jekk għandek bżonn xi raffinamenti!