Webhook – to mechanizm powiadamiania systemu i/lub systemów zewnętrznych o zdarzeniach telefonii lub Wirtualnej Centrali Ringostat w określonym momencie.
W przypadku wystąpienia zdarzenia, utworzonego wcześniej w panelu, webhook wysyła zapytanie HTTP z zestawem parametrów na adres URL, który został wskazany dla tego Webhooka.
Jeżeli URL, na który wysyłany jest Webhook, jest niedostępny (nie odpowiada kodem HTTP 200 OK), nie będą podejmowane próby ponownego wysyłania Webhooka na ten adres URL do momentu uzyskania oczekiwanego 200 OK. Webhook zostanie oznaczony jako „z błędem”, a jego status wysyłki oraz treść błędu będą dostępne do podglądu na stronie Sprawdzanie błędów Webhooks.
WebHooks — uproszczony wariant zdarzeń REST i komend REST, który nie wymaga pisania programu. Jednakże, mimo to, praca z REST pozostaje zadaniem złożonym, wymagającym wysokich kwalifikacji od dewelopera.
Zdarzenie – „Połączenie przychodzące”
przed połączeniem;
po połączeniu;
po menu oceny połączenia;
w momencie odebrania słuchawki;
w momencie przekierowania.
Zdarzenie – „Połączenie wychodzące”
przed połączeniem;
po połączeniu.
Zdarzenie – „Wysłanie formularza ze strony internetowej”
Zdarzenie – „Otwarcie/zamknięcie dialogu”
rozpoczęcie dialogu w komunikatorze;
zakończenie dialogu w komunikatorze.
Zdarzenie – „Umowa utworzona lub jej status zaktualizowany”
Tworzenie zapytania webhook
W Koncie Osobistym należy przejść do sekcji Integracja, a następnie na stronę Webhooks 2.0.
Strona zawiera tabelę aktywnych i skonfigurowanych integracji projektu. Domyślnie dodano i skonfigurowano zdarzenie „Po połączeniu” z webhookiem dla Google Analytics, którego nie można edytować.
Unikalne zdarzenie i nowe zapytanie webhook
Aby utworzyć nowe zapytanie webhook z nowym typem zdarzenia:
1. Proszę kliknąć „Dodaj unikalne zdarzenie”
Po kliknięciu przycisku otworzy się menu z ustawieniami
2. Proszę wypełnić pola dla nowego zdarzenia:
W polu Nazwa proszę podać nazwę zdarzenia (np. „Przed połączeniem”, jeżeli typ zdarzenia jest odpowiedni).
3. Proszę wybrać zdarzenie z listy.
4. Dodanie parametrów dla nowego zapytania webhook:
Kierunek – adres handlera, na który zostanie wysłane zapytanie. Standardowe porty: 80 dla HTTP oraz 443 dla HTTPS. Dla ustawienia Webhooka na URL z podanym portem można przesłać adres URL w formacie:
http://11.111.111.11:80Nagłówki – automatycznie dodawane są nagłówki Content-Type, zależnie od metody wysyłki. Można je edytować lub usunąć.
Metoda wysyłki danych:
GET – zapytanie z przekazaniem parametrów w pasku adresu (URL zapytania);
POST – zapytanie z przekazaniem parametrów w treści (body) zapytania;
PUT – zapytanie do zmiany instancji o wskazanym ID.
Format wysyłki danych – format przekazywanych danych do handlera zapytania:
json – wysyłanie parametrów w formacie obiektu (para klucz/wartość) w zapytaniu;
raw – pozwala przesyłać dane w zapytaniu bez obróbki lub kodowania w określonym formacie (np. tekstowym, binarnym lub jako obraz);
json-rpc – protokół zdalnego wywoływania procedur wykorzystujący format JSON do przesyłania zapytań i odpowiedzi, definiujący strukturę z obowiązkowymi polami „jsonrpc”, „method” i „params”;
form – umożliwia przesyłanie danych w zapytaniu jako pary klucz/wartość kodowane w URL, najczęściej stosowane do przesyłania danych z formularzy na stronach internetowych.
Format daty – domyślnie ustawiona Standardowa data.
Typy parametrów:
Tekst – pole tekstowe, z listy można wybrać potrzebny parametr;
Tablica – pole staje się multiselektorem, można dodać kilka parametrów i przekazać je w tablicy;
Obiekt – można dodać zestaw pól i przekazać dane w obiekcie. Wewnątrz obiektów można dodawać kolejne obiekty i tablice, jeśli trzeba określić kilka poziomów zagnieżdżenia;
md5/crc32/sha1/sha256 hash – różne algorytmy haszujące używane do przekształcenia danych w ciąg znaków o stałej długości (hash), wykorzystywane do sprawdzania integralności danych oraz ochrony przed nieautoryzowanym dostępem.
Nowe zdarzenie z działaniem (zapytaniem webhook) zostało utworzone.
Kopiowanie zapytania webhook
Jeśli webhook został już utworzony, ale potrzebują Państwo stworzyć kolejny, identyczny z drobnymi zmianami, należy postąpić w następujący sposób:
Proszę kliknąć trzy kropki obok istniejącego zdarzenia i skopiować je.
Proszę wybrać typ zdarzenia i kliknąć „Dalej”.
Skopiowane zdarzenie należy zapisać.
Nowo utworzone zdarzenie można edytować i wprowadzić zmiany w polach.
Mogą Państwo również zobaczyć przykład webhooka, który zostanie wysłany, lub wysłać go testowo. Na dole, po wypełnieniu wszystkich parametrów, dostępne będą dwie opcje pod przyciskiem Preview: „Pokaż przykład” oraz „Wykonaj i pokaż przykład”.
Tam zostaną wskazane wszystkie dane oraz treść zapytania.
Ważne! Nazwa parametru musi być zapisana alfabetem łacińskim oraz bez spacji, w przeciwnym razie dane nie będą przekazywane poprawnie.
Jeżeli konieczna jest nazwa parametru wyłącznie cyrylicą oraz/lub ze spacjami, w takim przypadku należy ją zapisać w nawiasach klamrowych. Na przykład: {{nazwa parametru}}.
Na tym proces tworzenia zapytania webhook zostaje zakończony.