Webhooki

 

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 produkcyjnego adres webhook można dodać na stronie https://manager.paczkomaty.pl/zaloguj  w zakładce Moje konto >API.

Dla środowiska sandbox adres webhook można dodać na stronie InPost - Manager paczek  w zakładce Moje konto >API.

Na tej stronie



Struktura

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:

https://www.serwer.pl:8080/katalog1/katalog2/plik.xxx

 

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.


 

 

Dane wysyłane w przypadku gdy przesyłka zostanie utworzona

{ "event_ts": "2020-03-20 15:08:06 +0100", "event": "shipment_confirmed", "organization_id": 1, "payload": { "shipment_id": 49, "tracking_number": "602677439331630337653846" } }

 

Dane wysłane w przypadku gdy status przesyłki uległ zmianie

{ "event_ts": "2020-03-20 15:08:42 +0100", "event": "shipment_status_changed", "organization_id": 1, "payload": { "shipment_id": 49, "status": "delivered", "tracking_number": "602677439331630337653846" } }

 

Dane wysyłane w przypadku gdy przesyłka zostanie utworzona w statusie offers_prepared (przesyłka tworzona w trybie ofertowym)

 

Dane wysyłane w przypadku gdy przesyłka otrzyma status ZDN (Zwrot do Nadawcy - returned_to_sender)