🌐 Webhook Trigger

Webhook Trigger овозможува надворешни системи да иницираат работни текови во SmartFlow испраќајќи податоци преку API барања. Овој тригер е идеален за интеграција на SmartFlow со апликации на трети страни, овозможувајќи динамична и беспрекорна автоматизација на задачи.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Крајната URL адреса за webhook за примање на влезни барања. Оваа адреса автоматски се генерира за секој работен тек што користи овој тригер.
• Required: Yes
• Example:

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

2. Payload

• Type: object
• Description: Податоците испратени од надворешниот систем во телото на барањето. Овој payload може да вклучува прилагодени полиња во зависност од интеграцијата.
• Required: Yes
• Example:

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

3. Headers

• Type: object
• Description: Опционални заглавија што надворешниот систем може да ги вклучи за цели на автентикација или метаподатоци.
• Required: No
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Кога се создава работен тек со Webhook Trigger, SmartFlow генерира уникатна URL адреса за webhook.
   • Споделете ја оваа URL адреса со надворешниот систем за да ја конфигурирате нивната интеграција.

2. API Key Retrieval:

   • Одете на ChatModel Settings.
   • Отидете на Integration → Web.
   • Кликнете Copy API Key за да го добиете потребниот токен за автентикација.

3. Payload Structure:

   • Надворешните системи испраќаат податоци (payload) до URL адресата на webhook користејќи HTTP POST барање.
   • Payload-от мора да одговара на структурата што ја бара работниот тек.

4. Trigger Execution:

   • Кога webhook-от прима валидно барање, поврзаниот работен тек автоматски се активира.
   • SmartFlow ги обработува податоците, извршува дефинирани акции и враќа одговор ако е потребно.

---

💡 Употребни Случаи

1. Интеграција со CRM:

   • Сценарио: Клиент создава нова сметка во вашиот CRM систем.
   • Webhook: CRM-от испраќа POST барање до SmartFlow со детали за клиентот.
   • Работен тек: Испраќа добредојдовно е-писмо и го додава клиентот на вашата маркетинг листа.

2. Управување со Нарачки:

   • Сценарио: Платформа за е-трговија обработува нова нарачка.
   • Webhook: Платформата испраќа детали за нарачката до SmartFlow.
   • Работен тек: Ажурира инвентар, испраќа потврда за нарачка и известува складиштето.

3. Набљудување на Инциденти:

   • Сценарио: Систем за набљудување открива критична грешка.
   • Webhook: Системот испраќа известување до SmartFlow.
   • Работен тек: Создава извештај за инцидент и известува инженерскиот тим.

---

🔍 Пример Конфигурација

Входно Webhook Барање

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

---

🛠️ Најдобри Практики

1. Валидација:

   • Валидација на влезните барања за да се осигура интегритетот на податоците и да се спречи злоупотреба.
   • Користете безбедни хедери или токени за автентикација.

2. Безбедност на API Клучот:

   • Осигурајте дека API клучот добиен од ChatModel Settings → Integration → Web е безбеден и не е јавно изложен.

3. Мапирање на Податоци:

   • Јасно мапирајте ги влезните полиња на променливи во работниот тек за беспрекорно обработување.

4. Тестирање:

   • Тестирајте го webhook со примерни payloads за да осигурите компатибилност и доверливост.

5. Обработка на Грешки:

   • Конфигурирајте ги работните текови да се справуваат со недостасувачки или неправилно форматирани податоци на соодветен начин.

---

📊 Набљудување и Дебагирање

• Логови на Активности:
  Следете ги влезните webhook барања и нивниот статус на обработка во таблото на SmartFlow.

• Извештавање за Грешки:
  Идентификувајте неуспешни барања и прегледајте ги деталите за грешките за решавање на проблеми.

---

Оваа секција нуди детално упатство за Webhook Trigger, осигурувајќи дека корисниците можат да го интегрираат без проблем во своите работни текови. Дозволете ми да знам ако ви се потребни какви било подобрувања!