Webhook wysyła wiadomość na Twój własny adres za każdym razem, gdy coś dzieje się w Twoim obszarze roboczym, na przykład gdy zamówienie zostanie opłacone lub subskrypcja anulowana. Użyj go, aby utrzymać synchronizację z innym systemem, na przykład z narzędziem takim jak Zapier, Twoją księgowością lub Twoim własnym serwerem.
Zanim zaczniesz
Strona znajduje się w Płatności > Ustawienia > Webhooki, w grupie Dla deweloperów. Wyświetlenie jej wymaga Zobacz płatności. Dodawanie, zmiana, testowanie i usuwanie punktów końcowych wymaga Zaktualizuj zamówienia / klientów.
Dodawanie punktu końcowego
Kliknij przycisk dodawania, aby otworzyć Dodaj punkt końcowy:
- W Punkt końcowy nadaj mu opcjonalną Nazwa i wpisz URL punktu końcowego. Adres musi być dostępny z internetu. Adresy w sieci prywatnej są odrzucane.
- W Wydarzenia wybierz, co ma otrzymywać punkt końcowy. Szukaj zdarzeń zawęża listę, pole wyboru grupy zaznacza całą grupę, a Zaznacz wszystko lub Wyczyść wszystko zmienia wszystko naraz. Potrzebne jest co najmniej jedno zdarzenie.
- Kliknij Utwórz.
Zdarzenia są pogrupowane tematycznie:
- Płatności: Opłacono zamówienie, Przetwarzanie płatności, Płatność nieudana, Faktura opłacona, Utworzono zwrot.
- Subskrypcje: Utworzono subskrypcję, Odnowiono subskrypcję, Subskrypcja anulowana, Płatność za subskrypcję nieudana.
- Członkowie: rejestracje, logowania, dodane lub usunięte tagi, zmienione pola członków i nowe kontakty.
- Kursy i wydarzenia, Społeczność oraz Dane i skrzynka: ukończone kursy i lekcje, rejestracje na wydarzenia i obecność, posty, poziomy, odznaki, wiadomości w skrzynce i zgłoszenia.
- Partner: nowe prowizje i opłacone wypłaty, zobacz pomoc dotyczącą programu partnerskiego.
Sekret podpisu
Zaraz po utworzeniu punktu końcowego obszar roboczy jeden raz pokazuje jego sekret podpisu: Skopiuj teraz sekret podpisu. Zapisz go u siebie, a potem kliknij Gotowe. Nie zostanie pokazany ponownie.
Każde dostarczenie jest wysyłane jako JSON z nagłówkiem X-Maio-Signature. Zawiera on
HMAC-SHA256 surowej treści żądania, utworzony Twoim sekretem, jako ciąg
szesnastkowy małymi literami. Oblicz tę samą wartość u siebie i porównaj ją, aby mieć pewność, że
wiadomość pochodzi z Twojego obszaru roboczego. Nagłówki X-Maio-Event i
X-Maio-Delivery określają zdarzenie i dostarczenie.
Aby wymienić sekret, otwórz punkt końcowy i kliknij Zmień sekret. Stary sekret od razu przestaje działać, więc natychmiast zaktualizuj swój punkt końcowy.
Testowanie
Otwórz punkt końcowy i kliknij Wyślij test. Przycisk zmienia się na Test w kolejce, a zdarzenie testowe dociera do Twojego punktu końcowego w ciągu kilku chwil. Pojawia się w logu dostarczeń jak każde inne dostarczenie.
Log dostarczeń
Karta Log dostarczeń pokazuje każde dostarczenie z polami Zdarzenie, Punkt końcowy, Status, kodem HTTP, którym odpowiedział Twój punkt końcowy, Próby i Kiedy. Filtruj według Dostarczono, Nieudany lub Oczekuje. Sekcja Dostarczenia punktu końcowego pokazuje jego 20 ostatnich dostarczeń z błędem każdego nieudanego.
Dostarczenie uznaje się za udane, gdy Twój punkt końcowy odpowie kodem 2xx w ciągu 15 sekund. W przeciwnym razie jest ponawiane po 30 sekundach, 5 minutach, 30 minutach, 2 godzinach i 6 godzinach. Ponów wysyła dostarczenie ponownie z tą samą treścią.
Po 20 nieudanych próbach z rzędu dla zdarzenia to zdarzenie jest wyłączane dla punktu końcowego. Jeśli punkt końcowy odpowie kodem 410 Gone, zdarzenie jest wyłączane od razu. Napraw punkt końcowy, a potem przełącz go z powrotem na Aktywny.
Wyłączanie i usuwanie
W punkcie końcowym przełącznik przełącza między Aktywny a Wyłączone. Wyłączony punkt końcowy nic nie otrzymuje. Usuń usuwa go wraz ze wszystkimi zdarzeniami po potwierdzeniu.
Przez API
Aplikacje połączone przez API mogą konfigurować własne punkty końcowe przez
endpointy /api/v1/hooks i klucz API z zakresem webhooks:manage.
Pojawiają się na liście z plakietką API, a tutaj można zmienić tylko ich nazwę i status.
Nie mają Zmień sekret ani Wyślij test. Zobacz
Klucze API i dostęp dla deweloperów.