Skip to main content

Webhooki

Webhooki umozliwiaja odbieranie wywolan zwrotnych HTTP w czasie rzeczywistym, gdy zdarzenia wystepuja na Twoich instancjach WhatsApp. Zamiast odpytywac API, Wappfy przesyla zdarzenia na Twoj serwer w momencie ich wystapienia.

Obslugiwane zdarzenia

Wappfy obsluguje 12 typow zdarzen webhook:

Tworzenie webhooka

Zarejestruj endpoint webhook, aby zaczac odbierac zdarzenia.
Odpowiedz:

Opcje konfiguracji

Pole instance_id jest opcjonalne. Jesli pominiesz je, webhook bedzie odbierac zdarzenia ze wszystkich instancji na Twoim koncie.

Lista webhookow

Odpowiedz:

Aktualizacja webhooka

Zaktualizuj URL, zdarzenia lub konfiguracje istniejacego webhooka.

Usuwanie webhooka


Format danych dostarczenia

Gdy wystapi zdarzenie, Wappfy wysyla zapytanie POST na URL webhooka z nastepujaca struktura:

Pola danych


Weryfikacja sygnatury HMAC

Jesli podales secret podczas tworzenia webhooka, kazde dostarczenie bedzie zawierac naglowek X-Wappfy-Signature z sygnatura HMAC-SHA256 tresci zapytania. Zawsze weryfikuj te sygnature, aby upewnic sie, ze zapytanie pochodzi od Wappfy i nie zostalo zmodyfikowane.

Przyklady weryfikacji

Zawsze uzywaj porownania staloczasowego (jak timingSafeEqual lub hmac.compare_digest) przy weryfikacji sygnatur, aby zapobiec atakom czasowym.

Polityka ponownych prob

Jesli Twoj serwer nie odpowie kodem statusu 2xx w skonfigurowanym czasie timeout_ms, Wappfy ponowi probe dostarczenia.
Ponowne proby sa przerywane po otrzymaniu odpowiedzi 2xx lub wyczerpaniu retry_count. Domyslna liczba ponownych prob to 3.

Przegladanie historii dostarczen

Sprawdz dziennik dostarczen webhooka, aby zobaczyc poprzednie proby dostarczenia i ich wyniki.
Odpowiedz:

Przyklady danych zdarzen


Dobre praktyki

Odpowiadaj szybko

Zwroc status 200 w ciagu 5 sekund. Przetwarzaj zdarzenie asynchronicznie, aby uniknac limitow czasu.

Deduplikuj

Uzyj id dostarczenia do wykrywania i pomijania zduplikowanych dostarczen spowodowanych ponownymi probami.

Weryfikuj sygnatury

Zawsze waliduj naglowek X-Wappfy-Signature, jesli skonfigurowales sekret.

Uzywaj HTTPS

Adresy URL webhookow musza uzywac HTTPS. Endpointy HTTP beda odrzucane.