🌐 Webhook Trigger

Webhook Trigger gerir ytra kerfum kleift að hefja vinnuflæði í SmartFlow með því að senda gögn í gegnum API beiðnir. Þessi trigger er tilvalin til að samþætta SmartFlow við þriðja aðila forrit, sem gerir sjálfvirka og óslitna framkvæmd verkefna mögulega.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Endapunktur URL fyrir webhook til að taka á móti innkomandi beiðnum. Þetta er sjálfkrafa myndað fyrir hvert vinnuflæði sem notar þennan trigger.
• Required: Já
• Example:

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

2. Payload

• Type: object
• Description: Gögnin sem ytra kerfið sendir í beiðninni. Þessi payload getur innihaldið sérsniðnar reitir eftir samþættingunni.
• Required: Já
• Example:

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

3. Headers

• Type: object
• Description: Valfrjálsar fyrirsagnir sem ytra kerfið gæti falið fyrir auðkenningu eða metagögn.
• Required: Nei
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Þegar þú býrð til vinnuflæði með Webhook Trigger, myndar SmartFlow einstaka URL fyrir webhookinn.
   • Deildu þessari URL með ytra kerfinu til að stilla samþættinguna þeirra.

2. API Key Retrieval:

   • Fara í ChatModel Settings.
   • Farðu í Integration → Web.
   • Smelltu á Copy API Key til að sækja nauðsynlegu auðkenningartáknið.

3. Payload Structure:

   • Ytri kerfi senda gögn (payload) til webhook URL með HTTP POST beiðni.
   • Payloadinn verður að passa uppbyggingu sem krafist er af vinnuflæðinu.

4. Trigger Execution:

   • Þegar webhookinn fær gildar beiðnir, er tengda vinnuflæðið sjálfkrafa virkjað.
   • SmartFlow vinnur úr payloadinu, framkvæmir skilgreindar aðgerðir og skilar svörum ef nauðsyn krefur.

---

💡 Notkunartilvik

1. CRM Samþætting:

   • Aðstæður: Viðskiptavinur býr til nýjan reikning í CRM kerfinu þínu.
   • Webhook: CRM-ið sendir POST beiðni til SmartFlow með upplýsingum um viðskiptavininn.
   • Vinnuflæði: Sendir velkomin tölvupóst og bætir viðskiptavininn við markaðslista þinn.

2. Pöntunastjórnun:

   • Aðstæður: E-verslunarpallur fer í gegnum nýja pöntun.
   • Webhook: Pallurinn sendir pöntunarupplýsingar til SmartFlow.
   • Vinnuflæði: Uppfærir birgðir, sendir pöntun staðfestingarpóst og tilkynnir vöruhúsið.

3. Atburðavöktun:

   • Aðstæður: Vöktunarkerfi greinir alvarlegan villu.
   • Webhook: Kerfið sendir viðvörun til SmartFlow.
   • Vinnuflæði: Býr til atburðaskýrslu og tilkynnir verkfræðiteymið.

---

🔍 Dæmi um Stillingar

Innkomandi Webhook Beiðni

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

---

🛠️ Bestu Venjur

1. Staðfesting:

   • Staðfestu innkomandi beiðnir til að tryggja gögnin séu rétt og koma í veg fyrir misnotkun.
   • Notaðu öruggar fyrirsagnir eða tokens fyrir auðkenningu.

2. Öryggi API lykils:

   • Tryggðu að API lykillinn sem sóttur er úr ChatModel Settings → Integration → Web sé varðveittur örugglega og ekki sýndur opinberlega.

3. Gögnakortlagning:

   • Kortleggðu skýrt innkomandi reiti við vinnuflæðisbreytur fyrir óhindraða vinnslu.

4. Prófanir:

   • Prófaðu webhook-ið með sýnishornum af payload til að tryggja samhæfi og áreiðanleika.

5. Villumeðferð:

   • Stilltu vinnuflæði til að meðhöndla skort á gögnum eða rangar upplýsingar á faglegan hátt.

---

📊 Vöktun og Villuleit

• Virkniskýrslur:
  Fylgdu innkomandi webhook beiðnum og stöðu þeirra í stjórnborði SmartFlow.

• Villuskýrslur:
  Greindu misheppnaðar beiðnir og skoðaðu villuupplýsingar til að leysa vandamál.

---

Þessi kafli veitir ítarlega leiðbeiningar um Webhook Trigger, sem tryggir að notendur geti samþætt það óaðfinnanlega í vinnuflæði sín. Láttu mig vita ef þú þarft frekari úrbætur!