Webhooks

Webhook is used to send the user information about changes in the status of the shipment.

 


For a production environment, the webhook address can be added on the page https://manager.paczkomaty.pl/zaloguj  in the My Account> API tab.

For a sandbox environment, the webhook address can be added on the page https://sandbox-manager.paczkomaty.pl/  in the My Account> API tab.


Structure

The provided address must match 3 conditions.

  • Correct URL structure

  • access to the resource to which the entered URL points

  • resource should respond with HTTP 200 on request GET


URL structure example:

http://www.serwer.pl:8080/catalog1/catalog2/file.xxx where:
  • https (protocol)

  • www.serwer.pl (address)

  • 8080 (port)

  • /catalog1/catalog2/file.xxx (file path, please use lower case)

 

Please note that the webhooks are sent from the IP address range 91.216.25.0/24. This IP address range is applicable for webhooks sent in both production and sandbox environments.


 

Data example when the shipment has been created:

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

 

Data example when the shipment status has been changed:

{ "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" } }

 

Data example when the shipment status has been changed to offers_prepared:

 

Data example when the shipment receives the ZDN status (Return to Sender - returned_to_sender)