Zarządzanie webhookami

Webhooki wysyłają zdarzenia z aplikacji Klang na twój serwer. Użyj ich, aby zaktualizować system CRM, opublikować wiadomość w komunikatorze lub uruchomić dowolny proces, gdy zakończy się przetwarzanie spotkania.

Webhooki są osobiste. Każdy webhook należy do jednego użytkownika i otrzymuje zdarzenia tylko dla treści, do których ten użytkownik ma dostęp.

Utwórz webhook

1. Otwórz Ustawienia → Dla deweloperów → Webhooki
2. Kliknij Utwórz webhook

3. Wpisz URL, na który mają trafiać zdarzenia. Musi to być publiczny endpoint HTTPS
4. Opcjonalnie: dodaj Opis, aby później łatwiej rozpoznać webhook
5. W sekcji Zdarzenia wybierz zdarzenia, które chcesz subskrybować. Domyślnie zaznaczone są wszystkie trzy
6. Kliknij Utwórz

Po utworzeniu webhooka Klang pokaże pole Sekret podpisu. Skopiuj sekret i przechowuj w bezpiecznym miejscu. Możesz go też później odczytać na stronie szczegółów webhooka. Użyjesz go, aby sprawdzić, czy przychodzące żądania naprawdę pochodzą z aplikacji Klang.

Dostępne zdarzenia

• conversation.ready: transkrypcja i analiza AI są gotowe do pobrania
• conversation.failed: przetwarzanie spotkania lub pliku nie powiodło się
• conversation.deleted: usunięto spotkanie lub plik

Ładunek każdego zdarzenia zawiera identyfikator zdarzenia, typ zdarzenia i odwołanie do rozmowy. Pełny schemat ładunku, format nagłówka podpisu i przykładowy kod weryfikacji znajdziesz w dokumentacji webhooków.

Zdarzenia i automatyzacje

Endpoint na tej stronie może odbierać dwa różne rodzaje danych. Warto wiedzieć, który z nich konfigurujesz.

Zdarzenia informują, że coś się wydarzyło. conversation.ready zawiera identyfikator, tytuł i stan, a twój serwer pobiera potrzebne treści przez API.

Automatyzacje wysyłają samą treść. Automatyzacja działa tylko dla wybranych spotkań i dostarcza gotowy raport z wybranymi przez ciebie nazwami pól, bez konieczności odpytywania API przez twój serwer. Konfigurujesz to w miejscu docelowym Webhook w automatyzacji, a nie tutaj. Automatyzacje korzystają z tych samych endpointów, więc w obu przypadkach masz jeden adres, jeden sekret podpisu i jedną historię dostarczeń.

Endpoint używany wyłącznie przez automatyzacje nie subskrybuje żadnych zdarzeń, dlatego na tej stronie nie będzie miał zaznaczonego żadnego zdarzenia. To normalne.

Monitoruj dostarczenia

Kliknij dowolny webhook, aby otworzyć stronę jego szczegółów.

Strona szczegółów pokazuje:

• Status i adres URL na górze, wraz z przełącznikiem do wstrzymywania dostarczeń
• Sekret podpisu: kliknij Pokaż, aby go wyświetlić, lub Kopiuj, aby go skopiować
• Statystyki z 24 godzin: liczbę dostarczeń, odsetek błędów, średni czas odpowiedzi i aktywność
• Ostatnie dostarczenia: jeden wiersz na każdą próbę dostarczenia. Kliknij wiersz, aby zobaczyć treść żądania i odpowiedź twojego serwera

Klang ponawia nieudane dostarczenie maksymalnie sześć razy, wydłużając odstęp po każdej próbie, w ciągu około siedmiu godzin. Webhook jest automatycznie wstrzymywany, gdy pięć kolejnych dostarczeń zakończy się niepowodzeniem, a błędy powtarzają się od co najmniej doby. Krótka awaria go nie wyłączy. Napraw endpoint, a następnie ponownie włącz Odbieranie zdarzeń.

Wyślij zdarzenie testowe

Aby sprawdzić, czy endpoint działa:

1. Otwórz stronę szczegółów webhooka
2. Kliknij Wyślij zdarzenie testowe w prawym górnym rogu
3. Jeśli webhook subskrybuje więcej niż jedno zdarzenie, wybierz, które zdarzenie wysłać
4. Sprawdź, czy w sekcji Ostatnie dostarczenia pojawił się nowy wiersz

Zdarzenia testowe są oznaczone tagiem TEST i mają identyfikatory zaczynające się od evt_test_. Schemat ładunku jest taki sam jak w prawdziwym zdarzeniu, więc możesz sprawdzić obsługę zdarzeń od początku do końca.

Wstrzymaj lub usuń webhook

Na stronie szczegółów webhooka:

• Aby wstrzymać webhook, wyłącz Odbieranie zdarzeń. Klang przestanie wysyłać zdarzenia, ale zachowa webhook i jego historię
• Aby usunąć webhook, kliknij Edytuj, a następnie Usuń webhook na dole okna

Webhook możesz też wstrzymać lub usunąć z menu … na liście webhooków.

Następne kroki

• Przeczytaj dokumentację webhooków, aby poznać schematy ładunków i weryfikację podpisów
• Zarządzaj integracjami, aby wysyłać zdarzenia przez wbudowane usługi, takie jak Slack