Przejdź do głównej zawartości

🌐 Wyzwalacz Webhook

Wyzwalacz Webhook umożliwia zewnętrznym systemom inicjowanie przepływów pracy w SmartFlow poprzez wysyłanie danych za pomocą żądań API. Ten wyzwalacz jest idealny do integracji SmartFlow z aplikacjami firm trzecich, umożliwiając dynamiczną i bezproblemową automatyzację zadań.

pasted-image.png

📝 Szczegóły Wyzwalacza​

Nazwa: Webhook
Kategoria: Wyzwalacze

🔧 Parametry​

1. Webhook URL​

  • Typ: string
  • Opis: Adres URL punktu końcowego dla webhooka, aby odbierać przychodzące żądania. Jest on automatycznie generowany dla każdego workflow korzystającego z tego wyzwalacza.
  • Wymagane: Tak
  • Przykład: 
    https://api.smartflow.com/webhooks/{workflowId}

2. Payload​

  • Typ: object
  • Opis: Dane wysyłane przez zewnętrzny system w treści żądania. Ten payload może zawierać niestandardowe pola w zależności od integracji.
  • Wymagane: Tak
  • Przykład: 
    {
      "event": "order_created",
      "orderId": "12345",
      "customer": {
        "name": "John Doe",
        "email": "john@example.com"
      }
    }

3. Nagłówki​

  • Typ: object
  • Opis: Opcjonalne nagłówki, które zewnętrzny system może zawierać w celach uwierzytelniania lub metadanych.
  • Wymagane: Nie
  • Przykład: 
    {
      "Authorization": "Bearer your-api-key",
      "Content-Type": "application/json"
    }

🚀 Jak to działa​

  1. Konfiguracja URL Webhooka:

    • Podczas tworzenia workflow z wyzwalaczem Webhook, SmartFlow generuje unikalny URL dla webhooka.
    • Udostępnij ten URL zewnętrznemu systemowi, aby skonfigurować ich integrację.

  2. Pobieranie Klucza API:

    • Przejdź do Ustawienia ChatModel.
    • Przejdź do Integracja → Web.
    • Kliknij Kopiuj klucz API, aby pobrać niezbędny token uwierzytelniający.

  3. Struktura Payloadu:

    • Zewnętrzne systemy wysyłają dane (payload) do URL webhooka za pomocą żądania HTTP POST.
    • Payload musi odpowiadać strukturze wymaganej przez workflow.

  4. Wykonanie Wyzwalacza:

    • Gdy webhook otrzyma ważne żądanie, powiązany workflow jest automatycznie uruchamiany.
    • SmartFlow przetwarza payload, wykonuje zdefiniowane akcje i zwraca odpowiedź, jeśli to konieczne.

💡 Przykłady Zastosowania​

  1. Integracja z CRM:

    • Scenariusz: Klient zakłada nowe konto w Twoim systemie CRM.
    • Webhook: CRM wysyła żądanie POST do SmartFlow z danymi klienta.
    • Workflow: Wysyła powitalny e-mail i dodaje klienta do Twojej listy marketingowej.

  2. Zarządzanie Zamówieniami:

    • Scenariusz: Platforma e-commerce przetwarza nowe zamówienie.
    • Webhook: Platforma wysyła szczegóły zamówienia do SmartFlow.
    • Workflow: Aktualizuje stan magazynu, wysyła e-mail z potwierdzeniem zamówienia i powiadamia magazyn.

  3. Monitorowanie Incydentów:

    • Scenariusz: System monitorujący wykrywa krytyczny błąd.
    • Webhook: System wysyła alert do SmartFlow.
    • Workflow: Tworzy raport incydentu i powiadamia zespół inżynieryjny.

🔍 Przykładowa Konfiguracja​

Przychodzące Żądanie Webhook​

URL:

https://api.smartflow.com/webhooks/abc123

Payload:

{
  "event": "user_registered",
  "userId": "67890",
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Nagłówki:

{
  "Authorization": "Bearer 123456789",
  "Content-Type": "application/json"
}

🛠️ Najlepsze Praktyki​

  1. Walidacja:

    • Waliduj nadchodzące żądania, aby zapewnić integralność danych i zapobiec nadużyciom.
    • Używaj bezpiecznych nagłówków lub tokenów do uwierzytelniania.

  2. Bezpieczeństwo Klucza API:

    • Upewnij się, że klucz API uzyskany z ChatModel Settings → Integration → Web jest przechowywany w bezpieczny sposób i nie jest publicznie ujawniany.

  3. Mapowanie Danych:

    • Wyraźnie mapuj nadchodzące pola na zmienne robocze, aby zapewnić płynne przetwarzanie.

  4. Testowanie:

    • Testuj webhook z przykładowymi ładunkami, aby zapewnić zgodność i niezawodność.

  5. Obsługa Błędów:

    • Skonfiguruj przepływy pracy, aby obsługiwały brakujące lub źle sformatowane dane w sposób elegancki.

📊 Monitoring i Debugging​

  • Dzienniki aktywności:
    Śledź przychodzące żądania webhook i ich status przetwarzania w panelu SmartFlow.

  • Raportowanie błędów:
    Zidentyfikuj nieudane żądania i wyświetl szczegóły błędów w celu rozwiązania problemów.

Ta sekcja zawiera szczegółowy przewodnik dotyczący wyzwalacza webhook, zapewniając użytkownikom możliwość bezproblemowej integracji z ich przepływami pracy. Daj mi znać, jeśli potrzebujesz jakichkolwiek poprawek!