Przejdź do treści

Webhooki: powiadomienia do Twojego systemu

Aktualizacja:

Na tej stronie

Webhook działa jak SMS z powiadomieniem, tylko wysyłany do Twojego programu zamiast do człowieka. Gdy w SMS Portal|app coś się stanie, nasz serwer wysyła do wskazanego przez Ciebie adresu krótką wiadomość z danymi. Twój program może wtedy na przykład zapisać odpowiedź klienta w swojej bazie.

Dodaj webhook

  1. W menu panelu kliknij „Webhooki”.
  2. Kliknij „Utwórz webhook”.
  3. W polu „Nazwa (opcjonalnie)” wpisz krótką nazwę, na przykład „CRM produkcyjny”. Pomoże Ci odróżnić webhooki.
  4. W polu „Adres dostarczenia” wpisz adres w swoim systemie. Serwer wyśle tam żądania POST.
  5. W polu „Sekret podpisu” wpisz własny ciąg znaków albo kliknij „Wygeneruj”. Sekret służy do sprawdzenia, że dane naprawdę pochodzą od nas.
  6. W polu „Zdarzenia” zaznacz co najmniej jedno: MESSAGE_RECEIVED (SMS odebrany), MESSAGE_SENT (wysłany), MESSAGE_DELIVERED (dostarczony) lub MESSAGE_FAILED (nie wyszedł).
  7. Kliknij „Utwórz”.
Okno tworzenia webhooka z adresem dostarczenia, sekretem podpisu i listą zdarzeń
Okno tworzenia webhooka z adresem dostarczenia, sekretem podpisu i listą zdarzeń

Na karcie webhooka możesz go wyłączyć i włączyć przełącznikiem, edytować, skopiować adres oraz pokazać lub skopiować sekret. Możesz mieć do 5 webhooków.

Co dostaje Twój system

Każde powiadomienie to żądanie POST z danymi w formacie JSON i nagłówkiem X-Signature. Dane zawierają między innymi identyfikator wiadomości, numer, treść, identyfikator telefonu i nazwę zdarzenia w polu webhookEvent. Przykłady każdego zdarzenia znajdziesz na dole strony Webhooki, w sekcji „Instrukcja bezpieczeństwa i wdrożenia”.

Twój system powinien:

  1. Przyjąć żądanie POST.
  2. Odpowiedzieć kodem 2XX, na przykład 200.
  3. Zrobić to w ciągu 10 sekund.

Sprawdź podpis

Nagłówek X-Signature to podpis liczony algorytmem HMAC-SHA256 z danych i Twojego sekretu. Policz go po swojej stronie i porównaj. Jeśli się nie zgadza, odrzuć żądanie. Gotowe przykłady w Node.js i Pythonie są w zakładce „Weryfikacja” na stronie Webhooki.

Dziennik dostarczeń i ponowienia

Kliknij zakładkę „Dostarczenia”. Zobaczysz każde powiadomienie z kolumnami „Zdarzenie”, „Urządzenie”, „Status”, „Adres dostarczania” i „Utworzono”. Kliknięcie ikony oka otwiera dane, które poszły do Twojego systemu. Filtry zawężają listę po telefonie, webhooku, typie zdarzenia, statusie i dacie.

StatusCo znaczy
DostarczoneTwój system odpowiedział poprawnie.
OczekującePowiadomienie czeka na pierwszą próbę.
PonawianiePróba się nie udała, serwer spróbuje ponownie.
NieudaneSerwer przestał próbować.

Gdy Twój system nie odpowie poprawnie, ponowimy wysyłkę po: 3 minutach, 5 minutach, 30 minutach, 1 godzinie, 6 godzinach, 1 dniu, 3 dniach, 7 dniach i 30 dniach. Powiadomienie ma najwyżej 10 prób. Przy błędach klienta (kody 4XX) serwer przestaje po trzeciej próbie. Wyłączony webhook nie dostaje już powiadomień.

Pytania i odpowiedzi

Ile webhooków mogę mieć?
Do 5 na koncie. Gdy osiągniesz limit, usuń jeden, aby dodać kolejny.
Co jeśli mój system nie odpowie?
SMS Portal|app ponowi próbę po 3 minutach, potem po 5 i 30 minutach, 1 godzinie i dłużej, łącznie do 10 prób.

Nie znalazłeś odpowiedzi? Napisz do nas

Wyślij pierwszego SMS-a jeszcze dziś

Załóż darmowe konto, podłącz telefon i sprawdź, jak klienci reagują na wiadomości z Twojego numeru.