Webhooki dla wygenerowanej transkrypcji i podsumowania

Webhooki informują o zakończeniu procesu generowania transkrypcji lub podsumowania i automatycznie wysyłane są do wskazanego systemu zewnętrznego. Dzięki nim integracje mogą natychmiast reagować na dostępność nowych danych, bez konieczności cyklicznego odpytywania API. Webhook zawiera informacje pozwalające jednoznacznie powiązać podsumowanie z konkretnym połączeniem oraz pobrać jego treść poprzez EAPI. Rozwiązanie to usprawnia przepływ danych i umożliwia automatyzację procesów opartych na analizie rozmów.

Jak skonfigurować webhooki informujące o wygenerowanej transkrypcji i podsumowaniu?

1. W panelu Administratora wchodzimy w edycję kampanii.

2. W zakładce Podstawowe parametry zaznaczamy opcję:

   „Webhook – wysyłaj na adres URL informacje o zdarzeniach w systemie:”

3. Klikamy Konfiguruj – pojawi się okno umożliwiające dodanie zdarzeń wywołujących webhook.

4. Po kliknięciu Dodaj wybieramy zdarzenie z listy:

• Wygenerowano transkrypcję
• Wygenerowano podsumowanie

5. Dla każdego zdarzenia należy wskazać:
   • adres URL, na który zostanie wysłany webhook,

• dane autoryzacyjne (Basic Auth), dostępne po kliknięciu Autoryzacja.

  

6.Zapisujemy zmiany poprzez wybranie przycisku Zapisz.

7. Zapisujemy konfigurację kampanii.  

Struktura webhooka – wygenerowanie transkrypcji

{
  "eventName":"TranscriptionCreated",
  "fccInstance":"domena",
  "customerId":0000,
  "version":1,
  "createdAt":"2025-11-21T13:09:24+01:00",
  "data":
    {
      "calls_id":136,
      "date_time":"2025-11-21T13:09:24+01:00",
      "campaigns_id":5
    }
}

Opis pól:

• eventName – nazwa zdarzenia
• fccInstance – domena instancji Welyo, z której wysłano webhook
• customerId – identyfikator klienta
• version – wersja webhooka
• createdAt – data i godzina wygenerowania powiadomienia

W sekcji data :

• calls_id – identyfikator połączenia, dla którego wygenerowano transkrypcję
• date_time – data i godzina wygenerowania transkrypcji
• campaigns_id – identyfikator kampanii (wartość pusta, jeśli połączenie było realizowane poza kampanią)

Struktura webhooka – wygenerowanie podsumowania

{
"eventName":"SummaryCreated",
"fccInstance":"domena",
"customerId":0000,
"version":1,
"createdAt":"2025-11-21T13:11:14+01:00",
"data":
{
  "calls_id":136,
  "date_time":"2025-11-21T13:11:14+01:00",
  "campaigns_id":5
    }
}

Opis pól:

• eventName – nazwa zdarzenia
• fccInstance – domena instancji Welyo, z której wysłano webhook
• customerId – identyfikator klienta
• version – wersja webhooka
• createdAt – data i godzina wygenerowania powiadomienia

W sekcji data :

• calls_id – identyfikator połączenia, dla którego wygenerowano podsumowanie
• date_time – data i godzina wygenerowania podsumowania
• campaigns_id – identyfikator kampanii (lub pusty, jeśli połączenie nie dotyczyło kampanii)

Najczęstsze pytania i odpowiedzi (FAQ)

1. Czym są webhooki w Welyo?

Webhooki to automatyczne powiadomienia wysyłane z Welyo do zewnętrznego systemu, gdy w platformie wystąpi określone zdarzenie, np. wygenerowanie transkrypcji lub podsumowania rozmowy. Dzięki temu integracja nie musi sama sprawdzać dostępności danych - otrzymuje informację natychmiast po ich przygotowaniu.

2. Kiedy wysyłany jest webhook dotyczący transkrypcji lub podsumowania?

Webhook jest wysyłany automatycznie w momencie zakończenia procesu generowania transkrypcji lub podsumowania dla danego połączenia. Obejmuje jedynie dane identyfikacyjne - pełna treść jest dostępna przez EAPI.

3. Dlaczego treść transkrypcji lub podsumowania nie jest wysyłana w webhooku?

Transkrypcje i podsumowania mogą być bardzo obszerne. Wysyłanie ich w całości w webhooku mogłoby spowodować opóźnienia, problemy z obsługą danych lub niepotrzebne obciążenie systemu odbiorcy. Dlatego webhook przekazuje tylko metadane, a właściwą treść można pobrać poprzez EAPI.

4. Jak pobrać zawartość transkrykcji lub podsumowania?

Wystarczy wywołać odpowiednią akcję EAPI, przekazując calls_id  otrzymane w webhooku:

• pobranie transkrypcji,
• pobranie podsumowania (jeżeli transkrypcja istnieje).

5. Jakie dane zawiera webhook?

Webhook zawiera m.in.:

• nazwę zdarzenia (eventName ),
• domenę instancji Welyo (fccInstance ),
• identyfikator klienta (customerId ),
• datę wygenerowania transkrypcji lub podsumowania,
• calls_id  (połączenie, którego dotyczy zdarzenie),

• campaigns_id  (jeśli dotyczy kampanii).

  Pełną strukturę można znaleźć w artykule.

6. Czy mogę skonfigurować różne adresy URL dla różnych zdarzeń?

Tak. Każde zdarzenie może mieć własny adres URL oraz własne dane autoryzacyjne (Basic Auth).

7. Czy webhooki obsługują uwierzytelnianie?

Tak. W konfiguracji webhooka można ustawić uwierzytelnianie typu Basic Auth, które Welyo wykorzysta przy wysyłaniu powiadomienia.

8. Co jeśli mój system nie odbierze webhooka?

Webhook jest wysyłany jednorazowo. Rekomendujemy, aby system odbiorcy był przygotowany na stabilne przyjmowanie powiadomień i logowanie ewentualnych błędów. W celu zapewnienia spójności danych warto budować mechanizm ponownego pobrania transkrypcji lub podsumowania przez EAPI na podstawie historii połączeń.

9. Czy mogę przetestować webhooki przed wdrożeniem?

Tak. Możesz wskazać testowy adres URL (np. endpoint testowy, narzędzie typu webhook.site) i wygenerować testowe połączenie, aby sprawdzić, jak wygląda struktura webhooka oraz czy system poprawnie go przetwarza.

10. Gdzie znajdę dokumentację EAPI potrzebną do obsługi webhooków?

Dokumentacja EAPI dostępna jest w panelu Administratora Welyo w sekcji:

Administracja > Integracje > Dokumentacja API (wersja on-line)