Skip to content

Movement aborted
Webhook

Request

The movement was abandoned after it had started, for example the vehicle was not on site.

Bodyapplication/jsonrequired
schemaVersionstringrequired

Bumped only for a breaking change to this envelope.

eventIdstringrequired

Stable across redeliveries of the same event. Deduplicate on this.

occurredAtstring, (date-time)required

When the transition happened, as an ISO 8601 instant. The only instant in the payload.

occurredAtLocalstringrequired

The same instant at the offset of the site the event happened at.

referencestring

Your own identifier for the vehicle, as supplied on vehicle.externalVehicleId.

eventTypestringrequired
Value:"movement.aborted"
movementobject(AbortedMovement)required

The movement every event carries. Each event adds the fields it alone reports.

Payload
{
  "schemaVersion": "1.0",
  "eventId": "01JQ8W3H2K4M5N6P7R8S9T0V1W",
  "occurredAt": "2026-08-27T09:14:02.000Z",
  "occurredAtLocal": "2026-08-27T05:14:02-04:00",
  "reference": "STOCK-12345",
  "eventType": "movement.aborted",
  "movement": {
    "id": "01JQ8W3H2K4M5N6P7R8S9T0V1W",
    "status": "DELIVERED",
    "vin": "2T1BURHE2FC361469",
    "vrm": "string",
    "make": "Toyota",
    "model": "Corolla",
    "modelVariant": "LE",
    "businessArea": "Retail",
    "transportMethod": "DRIVEN",
    "notes": "string",
    "confirmedBy": "string",
    "originSiteId": "site-orchard-park",
    "originAddressLine1": "string",
    "originAddressPostcode": "string",
    "originScheduledOn": "2026-08-27",
    "originScheduledTimeslot": "ANYTIME",
    "originPredictedOn": "2026-08-27",
    "originPredictedTimeslot": "ANYTIME",
    "destinationSiteId": "site-lockport",
    "destinationAddressLine1": "string",
    "destinationAddressPostcode": "string",
    "destinationScheduledOn": "2026-08-27",
    "destinationScheduledTimeslot": "ANYTIME",
    "destinationPredictedOn": "2026-08-27",
    "destinationPredictedTimeslot": "ANYTIME",
    "driverName": "John Davidson",
    "abortReason": "NotOnSite"
  }
}

Responses

Return any 2xx to acknowledge. A non-2xx is retried on Svix's schedule; sustained failure disables the endpoint and notifies you.