Webhook is an excellent tool if you want to connect Deliveo to a system with which it is not yet integrated. You may need development (programming) capacity to create the code that processes the data that Deliveo provides. The external system could be an ERP system, an invoicing system, or anything else.
The data sent is always done with the POST method. As a GET parameter you can set any data you want (e.g. authentication token or key).
You will find switches under each webhook:
- Disabled - no call is made
- Simple - the webhook call is made with basic data
- Extended - the webhook call is made with extended data
The Webhook call can be triggered by the following events:
Create a 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.
Simple:
"deliveo_id" =>"DELIV25020302677"
"sender" =>"John Wick"
"sender_country" =>"EN
"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" => "Belgrade"
"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."
Extended:
"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" => "Belgrade"
"consignee_address" =>"Main street 1"
"consignee_apartment" => "B/21"
"consignee_phone" =>"+362012345678"
"consignee_email" =>"[email protected]"
"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"
"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. pickup
Simple:
"deliveo_id" => "DELI12345678910"
"location_id" => "125"
Extended:
"deliveo_id" => "DELIV25030494014"
"location_id" => "7"
"location_name" => "DEV-003"
"courierThe person who delivers and delivers parcels to the recipient._name" => "Joe CourierThe person who delivers and delivers parcels to the recipient."
"courierThe person who delivers and delivers parcels to the recipient._phone" => "+367012345678"
Transport
Simple:
"deliveo_id" => "DELI12345678910"
"location_id" =>"A22"
Extended:
"deliveo_id" => "DELI24050227112"
"location_id" =>"A22"
"location_id_old" =>"A13"
Successful delivery
Simple:
"deliveo_id" => "DELIV25030445511"
"payment" => "CASH"
Extended:
"deliveo_id" => "DELIV25030476575"
"payment" => "Cash"
"recipient" => "Charles Bronson"
Unsuccessful delivery attempt
Simple:
"deliveo_id" => "DELI25020884680"
"unsuccessful_id" => 5
Extended:
"deliveo_id" => "DELI25024404680"
"unsuccessful_id" => 5
"state" => "Was not at home"