# Job webhook

webhook type: JOB

Endpoint: POST Job
Version: 1.0.0

## Request fields (application/json):

  - `id` (string)

  - `shortNote` (string)

  - `updated` (string)

  - `created` (string)

  - `deleted` (boolean)

  - `attachments` (array)

  - `bookedBy` (object)

  - `bookedBy.uid` (string)

  - `bookedBy.email` (string)

  - `bookedBy.name` (string)

  - `updatedBy` (object)

  - `reconciledBy` (object)

  - `deletedBy` (object)

  - `deliveryReference` (string)
    A reference added by the dispatcher

  - `truckReference` (string)
    A reference added by the driver, e.g. docket number

  - `senderReference` (string,null)
    A reference added by the dispatcher

  - `receiverReference` (string,null)
    A reference added by the dispatcher

  - `truckSenderReference` (string,null)
    A reference added by the driver at pickup, e.g. weighbridge docket number

  - `truckReceiverReference` (string,null)
    A reference added by the driver at delivery, e.g. weighbridge docket number

  - `truckPickupBoLReference` (string,null)
    A Bill of Lading reference added by the driver at pickup, e.g. Bill of Lading number

  - `truckDeliveryBoLReference` (string,null)
    A Bill of Lading reference added by the driver at delivery, e.g. Bill of Lading number

  - `pickupDistanceReadingKm` (number,null)

  - `deliveryDistanceReadingKm` (number,null)

  - `distanceReadingDeltaKm` (number,null)
    The odometer distance difference between pickup and delivery

  - `pickupEngineHoursReading` (number,null)

  - `deliveryEngineHoursReading` (number,null)

  - `engineReadingDeltaHours` (number,null)
    The engine hours difference between pickup and delivery

  - `externalId` (string)

  - `orderId` (string)

  - `orderFriendlyName` (string)

  - `bookingId` (string)
    If the job is linked to a corporate booking, the bookingId

  - `customerId` (string)
    The M2X customer id for this job

  - `customerExternalId` (string)
    External customer id for this job

  - `customerIntegrationId` (string)
    Customer integration id for this job

  - `customerName` (string)
    Customer name for this job

  - `billingGroupId` (string)
    Billing Group for this job

  - `humanReadableId` (string)
    Human Readable Id for this Billing group

  - `billingGroupStatus` (string)
    Billing Group status for this job

  - `pickupLocation` (object)

  - `pickupLocation.addressText` (string, required)

  - `pickupLocation.latitude` (number, required)

  - `pickupLocation.longitude` (number, required)

  - `pickupLocation.locationName` (string, required)

  - `pickupLocation.locationId` (string,null)
    The M2X internal location id. When a location is manually created in M2X, this is a randomly generated unique identifier. If creating locations via API, the caller can set the Location ID.

  - `pickupLocation.externalId` (string,null)
    An optional external identifier assigned to the location. This ID can be provided when creating the location and is typically used for cross-system referencing or integration with external data sources.

  - `pickupLocation.timezone` (string)
    IANA (aka TZ database) timezone name
    Example: "Pacific/Auckland"

  - `pickupLocation.properties` (object,null)

  - `pickupRegions` (object)

  - `pickupRegions.dispatchRegionIds` (array)

  - `taskPickupTimestamp` (string)
    RFC3339 date time of the pickup

  - `taskStartPickupTimestamp` (string)
    RFC3339 date time of arrival at the pickup site

  - `taskEndPickupTimestamp` (string)
    RFC3339 date time of departure from the pickup site

  - `deliveryLocation` (object)

  - `deliveryRegions` (object)

  - `taskDeliveryTimestamp` (string)
    RFC3339 date time of the delivery

  - `taskStartDeliveryTimestamp` (string)
    RFC3339 date time of arrival at the delivery site

  - `taskEndDeliveryTimestamp` (string)
    RFC3339 date time of departure from the delivery site

  - `dispatchHub` (object)
    If the job was created from dispatch hub, the associated details

  - `dispatchHub.activityId` (string)

  - `dispatchHub.workId` (string)

  - `dispatchHub.type` (string)

  - `dispatchHub.subtypes` (array)

  - `dynamicFulfilment` (object)
    If the job was created from dynamic fulfilment, the associated details

  - `dynamicFulfilment.shiftId` (string)

  - `dynamicFulfilment.serviceDay` (string)

  - `dynamicFulfilment.pickupTaskId` (string)

  - `dynamicFulfilment.pickupConstraintId` (string)

  - `dynamicFulfilment.deliveryTaskId` (string)

  - `dynamicFulfilment.deliveryConstraintId` (string)

  - `dynamicFulfilment.dispatchGroupId` (string)

  - `vehicleId` (string)

  - `vehicleExternalId` (string)

  - `vehicleProperties` (object)

  - `assets` (object)

  - `assets.driver` (object)

  - `assets.driver.assetId` (string)
    uid for this asset

  - `assets.tractorUnit` (object)

  - `assets.trailers` (array)

  - `assets.miscAssets` (array)

  - `assets.isoContainers` (array)

  - `subcontractorId` (string)

  - `subcontractorExternalId` (string)

  - `subcontractorProperties` (object)

  - `transportRequirementsId` (string)
    M2X internal tracking id for the product type

  - `division` (string,null)
    The division of the job (e.g. bulk, general, livestock...)

  - `productCode` (string,null)
    M2X internal tracking id for the product code used

  - `productCodeName` (string,null)
    M2X name for the product code used

  - `productCodeExternalId` (string,null)
    External Id for product tracking

  - `productProperties` (object)

  - `productComponents` (array)
    The sub components of the product if present

  - `productComponents.proportion` (number)
    The percentage proportion of this component

  - `productComponents.quantity` (number)

  - `productComponents.description` (string)

  - `productComponents.product` (object)
    A component for a product

  - `productComponents.product.productCodeName` (string,null)
    Friendly name of the product code

  - `properties` (object,null)
    A key value store containing custom properties

  - `quantity` (number)
    The product quantity

  - `distanceKm` (number)
    The reference distance for the job

  - `precisionPrice` (number,null)
    The precision price for the job

  - `precisionTkm` (number,null)
    The precision tonne km for the job

  - `precisionKm` (number,null)
    The precision price for the job

  - `precisionHr` (number,null)
    The precision Hr for the job

  - `status` (string)
    Enum: "Booked", "Started", "Delivered", "Accepted"

  - `invoicable` (boolean)
    Whether the job is invoiceable or not

  - `priceTransport` (number,null)
    The allocated transport price

  - `priceFaf` (number,null)
    The allocated FAF

  - `podLink` (string,null)
    The link to the track and trace POC link

  - `pocLink` (string,null)
    The link to the track and trace POD link

  - `pod` (object)
    Task completion details, e.g. proof of delivery

  - `pod.pickup` (object)

  - `pod.pickup.signedBy` (string,null)
    Name of person signing (accepting responsibility)
    Example: "John Doe"

  - `pod.pickup.completedBy` (object,null)
    User that carried out this operation, e.g. Driver

  - `pod.pickup.completedBy.id` (string)
    The external user identifier for driver/device if set, otherwise the M2X internal userId

  - `pod.pickup.completedBy.name` (string,null)
    Human readable name of user, e.g. Driver's name

  - `pod.pickup.downloadUrl` (string,null)
    URL where proof of delivery PDF can be downloaded from
    Example: "https://m2x.app/apis/v0/resources/generalConsignments/TGX854-6OU9Ns9xm9E4JxP1YJYs-1670743772224/pod/pdf"

  - `pod.delivery` (object)

  - `booked` (object)

  - `booked.pickupTimestamp` (integer)
    Epoch timestamp (seconds since 1970) of the booked pickup

  - `booked.deliveryTimestamp` (integer)
    Epoch timestamp (seconds since 1970) of the booked delivery

  - `booked.productId` (string)
    M2X internal tracking id for the booked product type

  - `booked.productCode` (string,null)
    M2X internal tracking id for the booked product code used

  - `booked.quantity` (number)
    The booked product quantity

  - `booked.distanceKm` (number)
    The reference distance for the booked job

  - `docketMeasurementProperties` (object,null)
    A key value store containing docket measurement properties

  - `cancellationNotes` (string,null)
    Notes for the job cancellation

  - `cancellationReason` (string,null)
    Reason for the job cancellation

  - `pickupTimestamp` (integer)
    Epoch timestamp (seconds since 1970) of the pickup

  - `deliveryTimestamp` (integer)
    Epoch timestamp (seconds since 1970) of the delivery


## Response 200 fields