🌐 Webhook Tetikleyici

Webhook Tetikleyici xarici sistemlərin SmartFlow-da iş axınlarını başlatmasına imkan tanıyır, məlumatları API sorğuları vasitəsilə göndərir. Bu tetikleyici, SmartFlow-u üçüncü tərəf tətbiqləri ilə inteqrasiya etmək üçün idealdır, tapşırıqların dinamik və problemsiz avtomatlaşdırılmasını təmin edir.

---

📝 Tetikleyici Təfərrüatları

Ad: Webhook
Kateqoriya: Tetikleyicilər

---

🔧 Parametrlər

1. Webhook URL

• Tip: string
• Təsvir: Webhook-un daxil olan sorğuları qəbul etmək üçün endpoint URL. Bu, bu tetikleyicidən istifadə edən hər bir iş axını üçün avtomatik olaraq yaradılır.
• Tələb olunur: Bəli
• Nümunə:

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

2. Payload

• Tip: object
• Təsvir: Xarici sistem tərəfindən sorğu bədənində göndərilən məlumat. Bu payload inteqrasiyadan asılı olaraq xüsusi sahələri əhatə edə bilər.
• Tələb olunur: Bəli
• Nümunə:

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

3. Headers

• Tip: object
• Təsvir: Xarici sistemin autentifikasiya və ya metadata məqsədləri üçün daxil edə biləcəyi əlavə başlıqlar.
• Tələb olunur: Xeyr
• Nümunə:

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

---

🚀 Necə İşləyir

1. Webhook URL Konfiqurasiyası:

   • Webhook Tetikleyici ilə iş axını yaradarkən, SmartFlow webhook üçün unikal URL yaradır.
   • Bu URL-i xarici sistemlə paylaşın ki, onların inteqrasiyasını konfiqurasiya etsinlər.

2. API Açarının Alınması:

   • ChatModel Ayarları bölməsinə keçin.
   • İnteqrasiya → Veb-ə daxil olun.
   • Tələb olunan autentifikasiya tokenini əldə etmək üçün API Açarını Kopyala düyməsini basın.

3. Payload Struktur:

   • Xarici sistemlər HTTP POST sorğusu istifadə edərək webhook URL-ə məlumat (payload) göndərir.
   • Payload iş axınının tələb etdiyi struktura uyğun olmalıdır.

4. Tetikleyici İcraatı:

   • Webhook etibarlı bir sorğu aldıqda, əlaqəli iş axını avtomatik olaraq tetiklenir.
   • SmartFlow payload-u emal edir, müəyyən edilmiş hərəkətləri icra edir və lazım olduqda cavab qaytarır.

---

💡 İstifadə Halları

1. CRM İnteqrasiyası:

   • Ssenari: Müştəri sizin CRM sisteminizdə yeni hesab yaradır.
   • Webhook: CRM müştəri məlumatları ilə SmartFlow-a POST sorğusu göndərir.
   • İş Prosesi: Müştəriyə xoş gəlmisiniz e-poçtu göndərir və onu marketinq siyahınıza əlavə edir.

2. Sifariş İdarəetməsi:

   • Ssenari: E-ticarət platforması yeni sifarişi emal edir.
   • Webhook: Platforma sifariş məlumatlarını SmartFlow-a göndərir.
   • İş Prosesi: Anbarı yeniləyir, sifariş təsdiq e-poçtu göndərir və anbarı xəbərdar edir.

3. Hadisə Monitorinqi:

   • Ssenari: Monitorinq sistemi kritik bir səhvi aşkar edir.
   • Webhook: Sistem SmartFlow-a xəbərdarlıq göndərir.
   • İş Prosesi: Hadisə hesabatı yaradır və mühəndislik komandasını xəbərdar edir.

---

🔍 Nümunə Konfiqurasiya

Gələn Webhook Sorğusu

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

---

🛠️ Ən Yaxşı Təcrübələr

1. Təsdiqləmə:

   • Gələn sorğuları təsdiqləyin ki, məlumatların bütövlüyünü təmin edəsiniz və sui-istifadənin qarşısını alasınız.
   • Doğrulama üçün təhlükəsiz başlıqlar və ya tokenlər istifadə edin.

2. API Açarı Təhlükəsizliyi:

   • ChatModel Settings → Integration → Web bölməsindən əldə olunan API açarının təhlükəsiz saxlanmasını və ictimaiyyətə açıq olmamasını təmin edin.

3. Məlumat Xəritələşdirmə:

   • Gələn sahələri iş prosesi dəyişənlərinə aydın şəkildə xəritələşdirin ki, emal problemsiz olsun.

4. Test Etmə:

   • Uyğunluq və etibarlılığı təmin etmək üçün webhook-u nümunə payload-ları ilə test edin.

5. Səhv İdarəetməsi:

   • İstifadə olunmayan və ya yanlış formatda olan məlumatları gözəl şəkildə idarə etmək üçün iş proseslərini konfiqurasiya edin.

---

📊 Monitorinq və Debugging

• Fəaliyyət Gündəlikləri:
  Gələn webhook sorğularını və onların emal statusunu SmartFlow-un panelində izləyin.

• Səhv Hesabatı:
  Uğursuz sorğuları müəyyənləşdirin və problemlərin həlli üçün səhv detalları görün.

---

Bu bölmə Webhook Trigger üçün ətraflı bir bələdçi təqdim edir, istifadəçilərin onu iş proseslərinə problemsiz inteqrasiya etmələrini təmin edir. Hər hansı bir düzəlişə ehtiyacınız varsa, mənə bildirin!