🌐 Webhook Trigger

Webhook Trigger позволява на външни системи да инициират работни потоци в SmartFlow, като изпращат данни чрез API заявки. Този тригер е идеален за интегриране на SmartFlow с приложения на трети страни, позволявайки динамична и безпроблемна автоматизация на задачи.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Точката на достъп (endpoint) URL за webhook-а, за да получава входящи заявки. Тази URL адреса се генерира автоматично за всеки работен поток, използващ този тригер.
• 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 обработва payload-а, изпълнява определените действия и връща отговор, ако е необходимо.

---

💡 Използване на случаи

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, осигурявайки на потребителите възможността да го интегрират безпроблемно в своите работни потоци. Уведомете ме, ако имате нужда от допълнителни уточнения!