Webhook jest efektywną i prostą metodą komunikacji pomiędzy aplikacjami pozwalający na wysyłanie powiadomień pod ustalony adres URL, bezpośrednio po zmianie statusu przesyłki. Dzięki temu zintegrowane aplikacje zewnętrzne zostają natychmiast powiadomione o wystąpieniu zmian bez wymogu powtarzającego się odpytywania API o status przesyłki.
Dla środowiska sandbox adres webhook można dodać na stronie https://sandbox-manager.paczkomaty.pl/ w zakładce Moje konto >API. |
Na tej stronie
Przekazany adres musi spełniać 3 podstawowe warunki
poprawna budowa adresu URL
dostęp do zasobu, do którego kieruje wprowadzony adres URL
zasób powinien odpowiedzieć kodem HTTP 200
na zapytanie GET
Przykładowa struktura adresu:
|
Gdzie:
https
(protokół)
www.serwer.pl
(adres)
8080
(port)
/katalog1/katalog2/plik.xxx
(ścieżka do pliku, proszę podawać małą literą)
Należy pamiętać, że webhooki są wysyłane z zakresu adresów IP 91.216.25.0/24. Ten zakres adresów IP ma zastosowanie do webhooków wysyłanych w środowisku produkcujnym jak i sandbox. |
|
|
|
{ "event_ts": "2023-05-23 14:56:01 +0200", "event": "shipment_status_changed", "organization_id": 12345, "payload": { "shipment_id": 709709700, "status": "returned_to_sender", "tracking_number": "630055758325001130630004", "return_tracking_number": "520107015145404000176000" } } |