[1.23.0] Webhooks

Warning!

The resource is available only in the following countries: PL, IT

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

On this page

1 Structure
2 Data example when the shipment has been created:
3 Data example when the shipment status has been changed:
4 Data example when the shipment status has been changed to offers_prepared:

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

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)

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": null
  }
}

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": null
  }
}

Structure

Data example when the shipment has been created:

Data example when the shipment status has been changed:

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