event_name | string | The specific webhook event that triggered the notification (e.g., pickup_complete). |
status | string | The current high-level status of the delivery task. |
price | object | An object representing the total cost of the delivery. |
price.value | number | The total price of the delivery in a standard decimal format, converted from cents. |
price.currency | string | The ISO 4217 currency code for the price. |
currency | string | The ISO 4217 currency code for the transaction. |
distance | object | An object representing the estimated driving distance for the delivery. |
distance.value | number | The estimated driving distance value (e.g., in kilometers). |
distance.unit | string | The unit of measurement for the distance (e.g., kilometers). |
pickup_name | string | The full name of the contact person at the pickup location. |
dropoff_name | string | The full name of the contact person at the dropoff location. |
delivery_date | string | The scheduled date for the delivery to begin, formatted as YYYY-MM-DD. |
delivery_start_time | string | The scheduled start time for the delivery window, formatted as HH:MM:SS. |
partner_payload | object | An arbitrary object provided by the partner during job creation for their own reference. |
driver_id | number | A unique numeric identifier for the courier/driver. |
driver_name | string | The full name of the assigned courier. |
driver_location | object | The last known GPS coordinates of the driver. |
driver_location.lat | number | The latitude of the driver’s location. |
driver_location.lng | number | The longitude of the driver’s location. |
driver_dropoff_phone_number | string | The driver’s phone number for dropoff-related communication. |
driver_pickup_phone_number | string | The driver’s phone number for pickup-related communication. |
driver_vehicle_make | string | The make of the driver’s vehicle (e.g., Tesla). |
driver_vehicle_model | string | The model of the driver’s vehicle (e.g., Model Z). |
driver_vehicle_year | number | The manufacturing year of the driver’s vehicle. |
dropoff_time_estimated | string | The estimated time of arrival at the dropoff location, in a standard datetime format. |
pickup_address_street | string | Street name of the pickup address. |
pickup_address_city | string | City of the pickup address. |
pickup_address_country | string | Country of the pickup address. |
pickup_address_number | string | Street number of the pickup address. |
pickup_address_secondary_number | string | Apartment or suite number for the pickup address. |
pickup_address_county | string | County of the pickup address. |
pickup_address_state | string | State of the pickup address. |
pickup_address_postal_code | string | Postal or ZIP code of the pickup address. |
pickup_address_latitude | number | Latitude coordinate of the pickup address. |
pickup_address_longitude | number | Longitude coordinate of the pickup address. |
dropoff_address_street | string | Street name of the dropoff address. |
dropoff_address_city | string | City of the dropoff address. |
dropoff_address_country | string | Country of the dropoff address. |
dropoff_address_number | string | Street number of the dropoff address. |
dropoff_address_secondary_number | string | Apartment or suite number for the dropoff address. |
dropoff_address_county | string | County of the dropoff address. |
dropoff_address_state | string | State of the dropoff address. |
dropoff_address_postal_code | string | Postal or ZIP code of the dropoff address. |
dropoff_address_latitude | number | Latitude coordinate of the dropoff address. |
dropoff_address_longitude | number | Longitude coordinate of the dropoff address. |
pickup_phone_number | string | The contact phone number for the pickup location. |
pickup_instructions | string | Special instructions for the courier at the pickup location. |
email | string | The email address of the contact person at the pickup location. |
dropoff_phone_number | string | The contact phone number for the dropoff location. |
dropoff_instructions | string | Special instructions for the courier at the dropoff location. |
dropoff_email | string | The email of the entity to contact. |
package_description | string | A description of the contents of the package being delivered. |
package_minimum_vehicle_size | string | The minimum vehicle size required for this delivery (e.g., CAR, BIKE). |
package_delivery_mode | string | The delivery mode, indicating if it’s on-demand (NOW) or scheduled. |
package_requirements | array | A list of special requirements for the delivery (e.g., photo_proof_of_delivery). |
items_count | number | The number of items in the package. |
items | array | A list of objects, each detailing an item in the package. Can be null. |
weight | number | The weight of the package. |
dimentions | object | The dimentions of the package. |
package_value | number | The declared value of the package, converted from cents. |
pickup_start_time | string | The start time of the pickup window, formatted as HH:MM:SS. |
dropoff_start_time | string | The start time of the dropoff window, formatted as HH:MM:SS. |
delivery_end_time | string | The end time of the dropoff window, formatted as HH:MM:SS. |
dropoff_verification_image_url | string | URL to a photo taken as proof of delivery. Available on relevant events. |
dropoff_signature_image_url | string | URL to a signature captured as proof of delivery. Available on relevant events. |
cancellation_reason | string | The reason for a delivery cancellation. Available on cancellation events. |
tip | number | The tip amount for the driver, converted from cents. |
partner_reference | string | A reference ID provided by the partner during job creation. |
