Evermile Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
Event Types
order
object
The details of a booked order
56 Items
timestamp
string
(date-time)
The time this callback was sent in ISO8601 format
Example order.created
JSON
{
"order": {
"actualDropoff": "2024-04-09T13:57:55.163Z",
"actualPickup": "2024-04-09T11:55:55.163Z",
"actualVehicleType": "car",
"additionalProperties": {},
"communicatedDropoff": {
"end": "2024-04-09T15:00:00:00.000Z",
"start": "2024-04-09T11:00:00.000Z"
},
"communicatedPickup": {
"end": "2024-04-09T15:00:00:00.000Z",
"start": "2024-04-09T11:00:00.000Z"
},
"costBreakdown": [
{
"name": "CostItemDeliveryCost",
"price": {
"bookingFeeCents": 100,
"currency": "GBP",
"discount": {
"discountPercent": 10,
"listPriceCents": 420,
"reason": "batching"
},
"liabilityPriceCents": 200,
"value": 678
}
}
],
"courierLocation": {
"lat": 51.529483875563876,
"lng": -0.12406103897631127
},
"customer": {
"email": "joe@malone.org",
"id": "87ee2ca2-6715-4e46-9dd1-bd9a0c373542",
"name": "Joe Malone",
"phone": "+441234567890",
"recipientId": "30adc349-27ce-4b10-8d70-f8d1cafb0255"
},
"customerTrackingUrl": "https://p.evml.io/GFASD4",
"deliveryCompany": "Uber",
"deliveryMethod": "delivery",
"destination": {
"addressLine1": "10 Argyle Street",
"addressLine2": "The Standard Hotel",
"city": "London",
"external": false,
"geoLocation": {
"lat": 51.529483875563876,
"lng": -0.12406103897631127
},
"postalCode": "NW1 2ST"
},
"dropoffEta": "2024-04-09T13:57:55.163Z",
"estimatedPickupWithinStoreHours": true,
"expectedVehicleType": "car",
"externalOrderId": "Order 1",
"handling": [
"alcohol"
],
"id": "0674ad55-9ad4-4e06-ad36-af69623f5cf7",
"instructions": "Please leave at reception",
"isGift": true,
"isReturn": false,
"labelPrintTime": "2024-04-09T10:55:55.163Z",
"labelRequired": false,
"labelUrl": "https://p.evml.io/GFASD4",
"merchantName": "Evermile Merchant",
"notes": [
"Was left at reception"
],
"orderTrackingInfo": {
"courierLocation": {
"lat": 51.529483875563876,
"lng": -0.12406103897631127
},
"courierName": "Isaac",
"courierPhone": "+441234567890",
"dropoffEta": "2024-04-09T11:55:55.163Z",
"dropoffWindowEnd": "2024-04-09T11:55:55.163Z",
"dropoffWindowStart": "2024-04-09T11:55:55.163Z",
"dropoffWindowType": "committed",
"isCourierAssigned": true,
"isOnWayToPickup": true,
"labelUrl": "https://p.evml.io/GFASD4",
"pickupEta": "2024-04-09T11:55:55.163Z",
"pickupWindowEnd": "2024-04-09T11:55:55.163Z",
"pickupWindowStart": "2024-04-09T11:55:55.163Z",
"vehicleType": "pushbike"
},
"origin": {
"addressLine1": "some string",
"addressLine2": "some string",
"city": "some string",
"external": true,
"geoLocation": {
"lat": 3.14,
"lng": 3.14
},
"name": "some string",
"postalCode": "some string",
"type": "office"
},
"parcels": [
{
"dimensions": {
"heightCm": 60,
"lengthCm": 70,
"name": "Case of Beer",
"widthCm": 60
},
"id": "7358891d-f6a1-4db5-a81d-efc90b95509e",
"parcelType": "Package",
"referenceId": "Ref-1",
"templateName": "Alcohol",
"weightKg": 8
}
],
"pickupContactInfo": {
"email": "jack@beers.co.uk",
"id": "73551241-7ca9-4459-bd68-6d3a71128147",
"name": "Jack Straw",
"phone": "+441234567890",
"recipientId": "3e6ff959-0765-42b7-940b-04eb2f57843d"
},
"pickupEta": "2024-04-09T11:55:55.163Z",
"proofOfDelivery": [
{
"type": "signature",
"urls": [
"some string"
]
}
],
"proofOfDeliveryRequirement": [
"signature"
],
"proposalTypes": [
"Green"
],
"recipientMessage": "some string",
"requestedSla": "express",
"routeInfo": {
"externalId": "some string",
"id": "270eade9-e61c-4780-94b3-0229976c3986",
"numOrders": 42
},
"scheduleInfo": {
"confirmed": true,
"scheduleDetails": {
"endCondition": "never",
"endDate": "some string",
"frequency": "daily",
"occurrencesLimit": 42,
"scheduledDate": "some string",
"weekdays": [
{
"day": "Monday"
}
]
},
"scheduleId": "77dbb446-ea5a-474e-8bb9-1edea6995e38",
"scheduledDate": "some string"
},
"senderContactDetails": {
"contactEmail": "some string",
"contactName": "some string",
"contactPhone": "some string",
"revealSenderInfo": true
},
"senderTrackingUrl": "some string",
"simulatedOrder": true,
"status": {
"lifeCycleStatus": "preCollection",
"manuallyUpdated": true,
"orderStatus": "Pending",
"reporter": "some string",
"reporting_time": "2024-04-09T11:55:55.163Z"
},
"usedCredits": true,
"username": "Jerry Garcia"
},
"timestamp": "2024-04-09T11:55:55.163Z"
}orderId
string
(uuid)
The ID of the order
timestamp
string
(date-time)
The time this callback was sent in ISO8601 format
trackingInfo
object
Live tracking info for an order
13 Items
updateKind
string
The details which were updated
Example order.liveUpdate
JSON
{
"orderId": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"timestamp": "2022-12-05T10:22:28.000Z",
"trackingInfo": {
"courierLocation": {
"lat": 51.511221,
"lng": -0.140666
},
"courierName": "John Smith",
"courierPhone": "+447883196637",
"dropoffEta": "2023-01-02T10:20:28.000Z",
"dropoffWindowEnd": "2023-01-02T10:20:28.000Z",
"dropoffWindowStart": "2023-01-02T10:20:28.000Z",
"dropoffWindowType": "committed",
"isCourierAssigned": true,
"isOnWayToPickup": true,
"pickupEta": "2023-01-02T10:20:28.000Z",
"pickupWindowEnd": "2023-01-02T10:20:28.000Z",
"pickupWindowStart": "2023-01-02T10:20:28.000Z",
"vehicleType": "pushbike"
},
"updateKind": "DropoffEta"
}order
object
The details of a booked order
56 Items
timestamp
string
(date-time)
The time this callback was sent in ISO8601 format
Example order.updated
JSON
{
"order": {
"actualDropoff": "2022-07-21T11:15:28.000Z",
"actualPickup": "2022-07-21T10:25:28.000Z",
"actualVehicleType": "pushbike",
"additionalProperties": {},
"communicatedDropoff": {
"end": "2022-07-21T17:32:28.000Z",
"start": "2022-07-21T10:20:28.000Z"
},
"communicatedPickup": {
"end": "2022-07-21T17:32:28.000Z",
"start": "2022-07-21T10:20:28.000Z"
},
"costBreakdown": [
{
"cancellationFeeInfo": {
"cancellationFeeType": "regularCancellationFee",
"originalCost": {
"bookingFeeCents": 500,
"currency": "GBP",
"discount": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"liabilityPriceCents": 500,
"value": 500
},
"percent": 15
},
"comment": "Following chat on Crisp",
"discountInfo": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"effectiveDate": "2022-07-21T10:25:28Z",
"itemId": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"liabilityInfo": {
"coverageCents": 10000
},
"name": "CostItemDeliveryCost",
"performedBy": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edf",
"price": {
"bookingFeeCents": 500,
"currency": "GBP",
"discount": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"liabilityPriceCents": 500,
"value": 500
},
"waiverDetails": {
"comment": "some string",
"dpRefundStatus": "some string",
"itemId": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edf",
"performedBy": "some string",
"price": {
"bookingFeeCents": 500,
"currency": "GBP",
"discount": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"liabilityPriceCents": 500,
"value": 500
},
"reason": "UserExperience"
}
}
],
"courierLocation": {
"lat": 51.511221,
"lng": -0.140666
},
"customer": {
"email": "johnsmith@email.com",
"id": "79f1f957-0bb2-4efa-9761-d224dc87c374",
"name": "some string",
"phone": 447883196637,
"recipientId": "89da19ce-6093-4bc0-a8e6-2e1d795a4124"
},
"customerTrackingUrl": "https://evml.io/FDS34RE2",
"deliveryCompany": "Evermile",
"deliveryMethod": "delivery",
"destination": {
"addressLine1": "32 Saville Row",
"addressLine2": "12",
"city": "London",
"external": false,
"geoLocation": {
"lat": 51.511221,
"lng": -0.140666
},
"name": "My book store",
"postalCode": "W1S 3PT",
"type": "store"
},
"dropoffEta": "2022-07-21T12:15:28.000Z",
"estimatedPickupWithinStoreHours": true,
"expectedVehicleType": "pushbike",
"externalOrderId": "Order_1234",
"extraExternalIds": [
"Order_1234",
"Order_1235"
],
"handling": [
"alcohol",
"fluids",
"fragile"
],
"handoffInfo": {
"contactInfo": {
"address": {
"addressLine1": "32 Saville Row",
"city": "London",
"postalCode": "W1S 3PT"
},
"name": "some string",
"phone": "+447883196637"
},
"handoffTime": {
"end": "2022-07-21T17:32:28.000Z",
"start": "2022-07-21T10:20:28.000Z"
},
"walkingDistanceMeters": 100
},
"handoffType": "receive",
"happiness": {
"created_at": "2021-01-01T00:00:00.000Z",
"created_by": "matan@evermile.io",
"is_happy": true,
"notes": "Cancelled by Evermile",
"update_source": "customer"
},
"id": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"instructions": "Fragile! Handle with care",
"isGift": false,
"isReturn": false,
"labelPrintTime": "2022-07-21T12:21:28.000Z",
"labelRequired": true,
"labelUrl": "https://webapp.prod.evermile.io/labels/order_label.pdf",
"liabilityCoverageCents": 10000,
"merchantName": "The Magic Wine Store",
"notes": [
"some string"
],
"orderTrackingInfo": {
"carrierDeliveryUrl": "url",
"carrierTrackingUrl": "https://tracking.evermile.io/order/f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"labelUrl": "url",
"courierLocation": {
"lat": 51.511221,
"lng": -0.140666
},
"courierName": "John Smith",
"courierPhone": "+447883196637",
"dropoffEta": "2023-01-02T10:20:28.000Z",
"dropoffWindowEnd": "2023-01-02T10:20:28.000Z",
"dropoffWindowStart": "2023-01-02T10:20:28.000Z",
"dropoffWindowType": "committed",
"isCourierAssigned": true,
"isOnWayToPickup": true,
"pickupEta": "2023-01-02T10:20:28.000Z",
"pickupWindowEnd": "2023-01-02T10:20:28.000Z",
"pickupWindowStart": "2023-01-02T10:20:28.000Z",
"vehicleType": "pushbike"
},
"origin": {
"addressLine1": "32 Saville Row",
"addressLine2": "12",
"city": "London",
"external": false,
"geoLocation": {
"lat": 51.511221,
"lng": -0.140666
},
"name": "My book store",
"postalCode": "W1S 3PT",
"type": "store"
},
"parcels": [
{
"id": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6ecc",
"dimensions": {
"heightCm": 5.1,
"lengthCm": 10.25,
"name": "M",
"widthCm": 8.25
},
"itemsList": [
{
"collectionConfig": {
"blackoutDates": [
{
"endDate": "2023-07-04T00:00:00.000Z",
"name": "Christmas",
"startDate": "2023-06-04T00:00:00.000Z"
}
],
"preparationConfig": {
"cutoffHour": "17:00",
"cutoffPreparationTime": {
"minHour": "some string",
"timeAmount": 60,
"timeUnit": "minutes"
},
"preparationTime": {
"minHour": "some string",
"timeAmount": 60,
"timeUnit": "minutes"
}
},
"schedule": {
"friday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
},
"monday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
},
"saturday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
},
"sunday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
},
"thursday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
},
"tuesday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
},
"wednesday": {
"end": "18:00",
"isOpen": true,
"start": "10:00"
}
}
},
"description": "Bottle of wine",
"quantity": 1,
"sku": "SK43234",
"value": {
"bookingFeeCents": 500,
"currency": "GBP",
"discount": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"liabilityPriceCents": 500,
"value": 500
},
"weightKg": 2.3
}
],
"parcelType": "Package",
"referenceId": "1",
"templateName": "some string",
"weightKg": 2.3
}
],
"pickupContactInfo": {
"email": "johnsmith@email.com",
"id": "40311fa2-e148-4b00-868d-aaf2e75f3282",
"name": "some string",
"phone": 447883196637,
"recipientId": "7b17eb5d-1800-47d7-b3b9-b1a2c4ad051d"
},
"pickupEta": "2022-07-21T10:25:28.000Z",
"proofOfDelivery": [
{
"type": "signature",
"urls": [
"https://myproofofdelivery/signature1"
]
}
],
"proofOfDeliveryRequirement": [
"signature",
"photoId"
],
"proposalTypes": [
"flexible"
],
"recipientMessage": "Happy birthday!",
"requestedSla": "express",
"routeInfo": {
"externalId": "R-F9BC2",
"id": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"numOrders": 5
},
"routeOrderIndex": 1,
"scheduleInfo": {
"confirmed": true,
"scheduleDetails": {
"endCondition": "byDate",
"endDate": "some string",
"frequency": "daily",
"occurrencesLimit": 42,
"scheduledDate": "some string",
"weekdays": [
{
"day": "Monday"
}
]
},
"scheduleId": "f27a9114-3fe2-4673-870c-88f479734c53",
"scheduledDate": "some string"
},
"senderContactDetails": {
"contactEmail": "johnsmith@email.com",
"contactName": "John Smith",
"contactPhone": 447883196637,
"revealSenderInfo": true
},
"senderTrackingUrl": "https://evml.io/FDS34RE2",
"simulatedOrder": false,
"status": {
"lifeCycleStatus": "final",
"manuallyUpdated": true,
"orderStatus": "OnWayToDropoff",
"reporter": "John",
"reporting_time": "2022-07-21T10:20:28.000Z"
},
"storeId": "f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"storeName": "The Magic Wine Store",
"totalValue": {
"bookingFeeCents": 500,
"currency": "GBP",
"discount": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"liabilityPriceCents": 500,
"value": 500
},
"trackingUrl": "https://tracking.evermile.io/order/f9bc2fa1-fa33-4b79-8fe5-f4fbe24c6edd",
"usedCredits": true,
"username": "John Doe",
"value": {
"bookingFeeCents": 500,
"currency": "GBP",
"discount": {
"discountPercent": 15,
"listPriceCents": 500,
"reason": "deliverTogether"
},
"liabilityPriceCents": 500,
"value": 500
}
},
"timestamp": "2022-12-05T10:22:28.000Z"
}