Saltar al contenido principal

Webhooks: Payload Fields

Every DashLink webhook contains a JSON payload with metadata describing the parcel's current state. Fields may be omitted if no data is available at that time.


Core Fields

FieldDescriptionAvailable For
contactlessWhether the delivery was contactlessAll events
created_atTimestamp when the webhook was createdAll events
currencyCurrency for fee/tip/order_valueAll events
event_nameName of the triggered eventAll events
external_delivery_idTracking code for the parcelAll events
order_valueValue of the goods shipped (cents)All events
feeDelivery fee chargedAll events
updated_atTimestamp when delivery info last updatedAll events
descriptionHuman-friendly description of eventAll events

Dasher & Vehicle Fields

FieldDescription
dasher_idUnique ID of the dasher
dasher_nameFirst name and last initial
dasher_dropoff_phone_numberPhone number to contact dasher at dropoff
dasher_pickup_phone_numberPhone number to contact dasher at pickup
dasher_locationDasher lat/lng
dasher_vehicle_makeMake of the dasher’s vehicle
dasher_vehicle_modelModel of the vehicle
dasher_vehicle_yearYear of the vehicle

Pickup & Dropoff Fields

FieldDescription
pickup_addressMerchant’s origin address
pickup_instructionsInstructions for pickup
pickup_phone_numberContact phone for pickup issues
pickup_reference_tagTracking code variant used internally
dropoff_addressFinal destination address
dropoff_phone_numberPhone number to contact recipient
dropoff_instructionsDelivery instructions
dropoff_contact_given_nameRecipient first name
dropoff_contact_family_nameRecipient last name
dropoff_contact_send_notificationsWhether SMS notifications are enabled

Time Fields

FieldDescriptionAvailable
pickup_time_actualWhen package was picked upAfter pickup
pickup_time_estimatedEstimated pickup timeAll events
dropoff_time_actualWhen package was deliveredAfter DASHER_DROPPED_OFF
dropoff_time_estimatedEstimated delivery timeAll events
return_time_actualWhen returned to facilityReturn events

Proof of Delivery Fields

FieldDescription
dropoff_verification_image_urlPOD photo; valid 7 days
dropoff_signature_image_urlSignature image, if applicable
pickup_verification_image_urlPickup verification image (peer-to-peer only)

Exception & Failure Fields

FieldDescription
undeliverable_reason_codeReason for failed attempt
undeliverable_reason_additional_detailsAdditional notes from dasher
return_reasonReason for return-to-merchant
parcel_delayed_reasonReason for delayed status
parcel_awaiting_reasonReason for awaiting status

Location Metadata

FieldDescription
package_location.cityCity where event occurred
package_location.state2-letter state
package_location.zip_codeZIP code
package_location.timezoneTime zone of event

Tracking

FieldDescription
tracking_urlCustomer-facing tracking URL
support_referenceReference for support cases