Webhooks are an excellent tool if you want to connect Deliveo to a system with which it does not yet have an integration. You may need development (programming) resources to write the code that processes the data sent by Deliveo. The external system could be an ERP system, an invoicing system, or anything else.
Data is always sent using the POST method. You can set any data you like as a GET parameter (e.g. an authentication token or key).
You will find toggles under each webhook:
- Off – no call is made
- Simplified – the webhook call is made with basic data
- Extended – the webhook call is made with extended data
The call is made immediately after the event occurs. You can view the call response data in the Webhook log: Log / Webhook log
The following events can trigger a Webhook call:
ShipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipment, even if it consists of several Packing Units., even if it consists of several Packing Units. creation
Data sent in a simple call:
"deliveo_id" => "DELIV25020302677"
"sender" => "John Wick"
"sender_country" => "HU"
"sender_zip" => "2340"
"sender_city" => "Kiskunlacháza"
"sender_address" => "Kinizsi 10"
"sender_apartment" => "Kinizsi 10"
"consignee" => "John Doe"
"consignee_country" => "HU"
"consignee_zip" => "2340"
"consignee_city" => "Belgrad"
"consignee_address" => "Main street 1"
"consignee_apartment" => "1"
"customer" => "Monster Inc."
"customer_country" => "HU"
"customer_zip" => "555666"
"customer_city" => "Los Angeles"
"customer_address" => "Baker str. 3."
"customer_building" => "3."
Data sent in an extended call:
"deliveo_id" => "DELIV25020302677"
"sender" => "John Wick"
"sender_country" => "HU"
"sender_zip" => "2340"
"sender_city" => "Kiskunlacháza"
"sender_address" => "Kinizsi 10"
"sender_apartment" => "A/2"
"sender_phone" => "+363012345678"
"sender_email" => "[email protected]"
"consignee" => "John Doe"
"consignee_country" => "HU"
"consignee_zip" => "2340"
"consignee_city" => "Belgrad"
"consignee_address" => "Main street 1"
"consignee_apartment" => "B/21"
"consignee_phone" => "+362012345678"
"consignee_email" => "[email protected]"
"customer_id" => "12345"
"customer" => "Monster Inc."
"customer_country" => "HU"
"customer_zip" => "555666"
"customer_city" => "Los Angeles"
"customer_address" => "3."
"customer_phone" => "+36305059287"
"customer_email" => "[email protected]"
"colliPackaging unit. Shows how many pieces are included in a given shipment." => "1"
"cod" => "0.00"
"referenceid" => "ref123456-ABC"
"tracking" => "tr_123456"
"sender_lat" => "12.34567890"
"sender_lng" => "12.34567890"
"consignee_lat" => "12.34567890"
"consignee_lng" => "12.34567890"
"courierThe person who delivers Shipments to the recipient._lat" => "12.34567890"
"courierThe person who delivers Shipments to the recipient._lng" => "12.34567890"
"packages" => array:1 [ 0 => array:4 [ "weight" => "1.00" "customcode" => "52061-760142_0" "x" => 5 "y" => 10 "z" => 15 ]
ShipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipment, even if it consists of several Packing Units., even if it consists of several Packing Units. received
Data sent in a simple call:
"deliveo_id" => "DELI12345678910"
"location_id" => "125"
Data sent in an extended call:
"deliveo_id" => "DELIV25030494014"
"location_id" => "7"
"location_name" => "DEV-003"
"courierThe person who delivers Shipments to the recipient._name" => "Joe CourierThe person who delivers Shipments to the recipient."
"courierThe person who delivers Shipments to the recipient._phone" => "+367012345678"
"location_type" => "vehicle / storage / pickup_point"
Transfer
Data sent in a standard call:
"deliveo_id" => "DELI12345678910"
"location_id" => "A22"
Data sent in an extended call:
"deliveo_id" => "DELI24050227112"
"location_id" => "A22"
"location_id_old" => "A13"
"location_type" => "vehicle / storage / pickup_point"
"location_country" => "Hrvatska"
"location_zip" => "10000"
"location_city" => "Zagrab"
"location_address" => "Martićeva ul. 71"
"location_lat" => "12.34567890"
"location_lng" => "12.34567890"
Successful delivery
Data sent in a standard call:
"deliveo_id" => "DELIV25030445511"
"payment" => "CASH"
Data sent in an extended call:
"deliveo_id" => "DELIV25030476575"
"payment" => "CASH"
"recipient" => "Charles Bronson"
Failed delivery attempt
Data sent in a simple call:
"deliveo_id" => "DELI25020884680"
"unsuccessful_id" => 5
Data sent in an extended call:
"deliveo_id" => "DELI25024404680"
"unsuccessful_id" => 5
"state" => "Was not home"
"close" => "true / false"