Event Object

A successful POST to a moves endpoint will return a modified request object, including additional information about the move or pair of moves.

For unsuccessful requests, please refer to Error Handling and Error Codes.

Additional Fields

TBD

Example Object — Move Event

POST /v1/concierge-loaner-moves

host: webhook.site
content-length: 1381
hopdrive-event: move_pickup_started
user-agent: HopDrive-Webhooks/1.0.0
hopdrive-signature: t=1661284695424,v1=589d916b3a6b27a40c8fed05eaa77f045bb30c4c056f0ae18b3ebd4beb011bbf
content-type: application/json
accept: application/json, text/plain

{
  "data": {
    "delivery_location": {
      "full_address": "888 W Broad St, Richmond, VA 23220, USA",
      "google_place_id": "Eic4ODggVyBCcm9hZCBTdCwgUmljaG1vbmQsIFZBIDIzMjIwLCBVU0EiMRIvChQKEgkPDdZ3SBGxiRG2k4LRA4YLvxD4BioUChIJHTvkZNsUsYkRci4sms_u2jU",
      "lat": 37.5504131,
      "location_id": 5883,
      "lon": -77.4492561,
      "name": "888 W Broad St"
    },
    "delivery_photos": [],
    "move": {
      "cancel_status": "not cancelled",
      "consumer_at_pickup": false,
      "dealer_contact": "Jane Smith",
      "delivery_arrived": null,
      "delivery_started": null,
      "delivery_successful": null,
      "distance_miles": 7.6,
      "driver_name": "John Driver",
      "id": 13081,
      "lane_uri": "https://api.hopdrive.com/v1/lanes/35924",
      "move_uri": "https://api.hopdrive.com/v1/moves/13081",
      "parent_scenario": {
        "cardinality": 0,
        "scenario_key": "concierge-loaner-pu",
        "moves": [
          {
            "cardinality": 0,
            "id": 13081,
            "move_type": "drive",
            "usecase_key": "concierge-loaner-pu",
            "pickup_time": "2022-08-23T19:58:15.424876+00:00",
            "consumer_at_pickup": false,
            "consumer_type": "customer"
          },
          {
            "cardinality": 1,
            "id": 13082,
            "move_type": "drive",
            "usecase_key": "concierge-loaner-pu",
            "pickup_time": null,
            "consumer_at_pickup": false,
            "consumer_type": "loaner"
          }
        ]
      },
      "pickup_arrived": "2022-08-23T19:58:17.777432+00:00",
      "pickup_started": "2022-08-23T19:58:15.424876+00:00",
      "pickup_successful": null,
      "portal_url": "https://dealer.hopdrive.io/moves/13081",
      "reference_num": "1234567",
      "rooftop": 42,
      "scenario_key": "concierge-loaner-pu",
      "settled": false,
      "special_instructions": "Check in at service center",
      "status": "pickup arrived",
      "usecase_key": "concierge-loaner-pu",
      "vehicle": {
        "color": "Black",
        "make": "Toyota",
        "model": "Avalon",
        "stock": "HS34928",
        "vin": "4HSLRBED5BJ2624333",
        "year": "2022"
      }
    },
    "pickup_location": {
      "full_address": "11161 Research Plz Wy, Richmond, VA 23236, USA",
      "google_place_id": "ChIJIeqBz3BtsYkRsHSettpjvPU",
      "lat": 37.5050987,
      "location_id": 5882,
      "lon": -77.601355,
      "name": "11161 Research Plz Wy"
    },
    "pickup_photos": [],
    "ready_by_time_utc": "2022-08-19T23:00:00+00:00"
  },
  "id": "ee887f20-231d-11ed-9c17-d1a5eafd48b0",
  "object": "event",
  "version": "1.0.0"
}

Example Object — Appointment Event

Appointment events carry the appointment object under data.appointment. The hopdrive-event header uses the underscore form of the event type (e.g. appointment_canceled for the appointment.canceled event). The body is always the full current state of the appointment regardless of which specific event fired — see the appointment object page for field-level details and notes on using source / updatedby for loop prevention.

POST {your_target_url}

host: webhook.site
content-length: 1024
hopdrive-event: appointment_canceled
user-agent: HopDrive-Webhooks/1.0.0
HopDrive-Signature: t=1763051550123,v1=2c8e7a91fbb6014d7e9c3a55124f7e8b9d6c2a1f8e7b4c3d2a1e0f9b8c7d6e5f
content-type: application/json
accept: application/json, text/plain

{
  "id": "a3f2b6c0-2c45-11ee-9f1a-7d8e3c4b5a01",
  "object": "event",
  "version": "1.0.0",
  "data": {
    "appointment": {
      "id": 48217,
      "status": "canceled",
      "external_id": "SLT-9938712",
      "source": "spark",
      "source_status": "Canceled",
      "transport_type": "valet",
      "consumer_vehicle_direction": "to_dealer",
      "appointment_time": "2026-05-20T14:30:00+00:00",
      "consumer_name": "Jordan Rivera",
      "consumer_phone": "+15555550143",
      "consumer_email": "jordan.rivera@example.com",
      "vehicle_make": "Toyota",
      "vehicle_model": "Camry",
      "vehicle_year": 2023,
      "vehicle_color": "Silver",
      "vehicle_vin": "4T1B11HK7KU123456",
      "vehicle_trim": "XSE",
      "ro_number": null,
      "loaner_requested": false,
      "move_id": null,
      "customer_id": 59,
      "driver_notes": null,
      "updatedat": "2026-05-13T18:05:33.117902+00:00",
      "updatedby": "spark-webhook"
    }
  }
}