🌐 Webhook Triggers

Webhook Triggers ļauj ārējiem sistēmām uzsākt darba plūsmas SmartFlow sistēmā, nosūtot datus, izmantojot API pieprasījumus. Šis triggers ir ideāls, lai integrētu SmartFlow ar trešo pušu lietojumprogrammām, ļaujot dinamiski un nevainojami automatizēt uzdevumus.

---

📝 Trigger Detaļas

Nosaukums: Webhook
Kategorija: Triggers

---

🔧 Parametri

1. Webhook URL

• Tips: string
• Apraksts: Beigu punkta URL, kur webhook saņem ienākošos pieprasījumus. Tas tiek automātiski ģenerēts katrai darba plūsmai, izmantojot šo triggeri.
• Nepieciešams: Jā
• Piemērs:

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

2. Payload

• Tips: object
• Apraksts: Dati, ko ārējā sistēma nosūta pieprasījuma ķermenī. Šis payload var ietvert pielāgotus laukus atkarībā no integrācijas.
• Nepieciešams: Jā
• Piemērs:

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

3. Headers

• Tips: object
• Apraksts: Papildus galvenes, kuras ārējā sistēma var iekļaut autentifikācijai vai metadatu nolūkiem.
• Nepieciešams: Nē
• Piemērs:

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

---

🚀 Kā tas darbojas

1. Webhook URL konfigurācija:

   • Izveidojot darba plūsmu ar Webhook Trigger, SmartFlow ģenerē unikālu URL webhook.
   • Kopīgojiet šo URL ar ārējo sistēmu, lai konfigurētu viņu integrāciju.

2. API atslēgas iegūšana:

   • Dodieties uz ChatModel Settings.
   • Iet uz Integration → Web.
   • Noklikšķiniet uz Copy API Key, lai iegūtu nepieciešamo autentifikācijas tokenu.

3. Payload struktūra:

   • Ārējās sistēmas nosūta datus (payload) uz webhook URL, izmantojot HTTP POST pieprasījumu.
   • Payload jāatbilst struktūrai, ko prasa darba plūsma.

4. Trigger izpilde:

   • Kad webhook saņem derīgu pieprasījumu, saistītā darba plūsma tiek automātiski uzsākta.
   • SmartFlow apstrādā payload, izpilda definētās darbības un, ja nepieciešams, atgriež atbildi.

---

💡 Lietošanas gadījumi

1. CRM integrācija:

   • Scenārijs: Klients izveido jaunu kontu jūsu CRM sistēmā.
   • Webhook: CRM nosūta POST pieprasījumu uz SmartFlow ar klienta datiem.
   • Darba plūsma: Nosūta sveiciena e-pastu un pievieno klientu jūsu mārketinga sarakstam.

2. Pasūtījumu pārvaldība:

   • Scenārijs: E-komercijas platforma apstrādā jaunu pasūtījumu.
   • Webhook: Platforma nosūta pasūtījuma datus uz SmartFlow.
   • Darba plūsma: Atjaunina krājumus, nosūta pasūtījuma apstiprinājuma e-pastu un informē noliktavu.

3. Incidentu uzraudzība:

   • Scenārijs: Uzraudzības sistēma konstatē kritisku kļūdu.
   • Webhook: Sistēma nosūta brīdinājumu uz SmartFlow.
   • Darba plūsma: Izveido incidenta ziņojumu un informē inženieru komandu.

---

🔍 Piemēra konfigurācija

Ienākošā Webhook pieprasījums

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

---

🛠️ Labākās prakses

1. Validācija:

   • Validējiet ienākošos pieprasījumus, lai nodrošinātu datu integritāti un novērstu ļaunprātīgu izmantošanu.
   • Izmantojiet drošus headerus vai tokenus autentifikācijai.

2. API atslēgas drošība:

   • Nodrošiniet, ka API atslēga, kas iegūta no ChatModel Settings → Integration → Web, tiek turēta drošībā un nav publiski pieejama.

3. Datu kartēšana:

   • Skaidri kartējiet ienākošos laukus uz darba plūsmas mainīgajiem, lai nodrošinātu nevainojamu apstrādi.

4. Testēšana:

   • Testējiet webhook ar paraugu payload, lai nodrošinātu saderību un uzticamību.

5. Kļūdu apstrāde:

   • Konfigurējiet darba plūsmas, lai tās varētu veiksmīgi apstrādāt trūkstošus vai nepareizi formatētus datus.

---

📊 Uzraudzība un atkļūdošana

• Darbības žurnāli:
  Izsekojiet ienākošos webhook pieprasījumus un to apstrādes statusu SmartFlow paneļa.

• Kļūdu ziņošana:
  Identificējiet neizdevušos pieprasījumus un skatiet kļūdu detaļas problēmu novēršanai.

---

Šī sadaļa sniedz detalizētu ceļvedi Webhook Trigger, nodrošinot, ka lietotāji to var vienkārši integrēt savās darba plūsmās. Informējiet, ja nepieciešamas kādas izmaiņas!