Shipday sends order update events via webhook subscription. Updates are sent over HTTP POST requests.

3rd party system needs to provide an endpoint to receive webhooks.

Along with providing an endpoint, the 3rd party system can provide a token (max 32 characters) to validate the webhook payload data. Validation token is sent in the webhook header data as “token”.

Attributes

webhook_payload

Example

{
    "timestamp": 1684644196349,
    "event": "ORDER_PIKEDUP",
    "order_status": "PICKED_UP",
    "order": {
        "id": 123456,
        "order_number": "808713698",
        "provider": "TOAST",
        "order_item": "[]",
        "delivery_note": "Please ring the doorbell twice",
        "order_source": "NOT PROVIDED",
        "auto_assignment_status": "NOT_ASSIGNED",
        "parent_id": 0,
        "order_sequence_number": 0,
        "payment_method":"CASH",
        "total_cost": 572.63,
        "delivery_fee": 38.63,
        "predefined_tip": 0,
        "cash_tip": 0,
        "discount_amount": 0,
        "tax": 0,
        "podUrls": ["https://s3-us-west-2.amazonaws.com/qt.com.dashboard.order.signature/a7dc65d0e8d44ef397e705512beb913d.jpg"],
        "driving_duration": 1060,
        "eta": "",
        "driving_distance": 5983,
        "placement_time": 1684643399000,
        "expected_pickup_time": 1684643998000,
        "expected_delivery_time": 1684645498000,
        "assigned_time": 1684644057000,
        "start_time": 1684644057000,
        "pickedup_time": 1684644196000,
        "arrived_time":1684644196000,
        "delivery_time":1684644196000
    },
    "company": {
        "id": 14849,
        "name": "Puzzles Dist Inc.",
        "description": "N/A",
        "address": "19 MANDALAY PL, SOUTH SAN FRANCISCO, CA 94080-1669, USA",
        "principal_area_id": 14848,
        "order_acceptance_timeout": 1800,
        "average_speed_mps": 8,
        "fixed_driver_fee": 0,
        "order_activation_time_mins": 90,
        "currency_code": 484,
        "schedule_order_lead_time_sec": 259200,
        "max_assigned_order": 3,
        "routing": 0,
        "country": 134,
        "admin_area": "SOUTH SAN FRANCISCO",
        "routing_cost": "DISTANCE"
    },
    "delivery_details": {
        "id": 12513717,
        "name": "John Doe",
        "phone": "123456789",
        "email": "john-doe@gmail.com",
        "address": "794 Mcallister St, San Francisco, CA, 94102",
        "formatted_address":"794 Mcallister St, San Francisco, CA, 94102",
        "location": {
            "lat": 19.3894172,
            "lng": -99.1845193
        }
    },
    "pickup_details": {
        "name": "Puzzles Foods",
        "phone": "1234566789",
        "address": "66 Ceres St, San Francisco, CA, 94124",
        "formatted_address": "66 Ceres St, San Francisco, CA, 94124",
        "location": {
            "lat": 19.4234928,
            "lng": -99.16628899999999
        }
    },
    "carrier": {
        "id": 134,
        "name": "Jane Doe",
        "phone": "45678432",
        "email": "jane-doe@gmail.com",
        "status": "ONLINE",
        "current_order": -1,
        "plate_number": "",
        "vehicle_description": ""
    },
    "thirdPartyDeliveryOrder": {
        "orderId": 343432,
        "thirdPartyName": "DoorDash 2",
        "referenceId": "12371573",
        "status": "STARTED",
        "insertedAt": 1684658096,
        "thirdPartyFee": 3.21,
        "driverName": "john efg",
        "driverPhone": "+11111111111"
    }
}