This operation describes the payload that our service will send to your webhook endpoint.
Warning: It is recommended to not use this way of ingesting data, the main payload should be preferred.
Note: The actual webhook URL is defined by you and is not part of our API domain. Please provide your endpoint URL when registering your webhook, along with supported Authentication Methods as described in Webhook Guide.
Ensure that your endpoint is properly configured to handle the payloads and respond with the appropriate HTTP status codes.webhook_endpoint_path_legacy_FTL required | string Your webhook path specified when creating your webhook configuration in the "url" field: e.g., url = "https://{webhook_base_url}/{webhook_endpoint_path}" (Create or update a push configuration.). |
JSON payload that will be sent to your webhook endpoint
OK
Created
Accepted
No Content
Invalid payload or other client error
Server error
{- "infoMessages": [
- {
- "severity": "ERROR",
- "message": "string",
- "diagnostic": "string",
- "source": "SYSTEM"
}
], - "latestStatusUpdate": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "statusCode": "DISPATCHED",
- "statusReason": {
- "code": "PENDING_TRACKING_METHOD",
- "description": "string"
}, - "stopNumber": 0,
- "timestamp": "string"
}, - "latestStopStatuses": [
- {
- "additionalAppointmentWindowStatuses": [
- {
- "scanDateTime": "2019-08-24T14:15:22Z",
- "windowType": "STRATEGIC",
- "statusCode": "EARLY"
}
], - "arrivalCode": "UNKNOWN",
- "arrivalDateTime": "string",
- "arrivalEstimate": {
- "estimatedArrivalWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z"
}, - "lastCalculatedDateTime": "string"
}, - "departureDateTime": "string",
- "statusCode": "UNKNOWN",
- "stopNumber": 0
}
], - "mapUrl": "string",
- "notificationRule": {
- "ruleInfo": { },
- "ruleType": "DEPRECATED_SHIPMENT_LATE"
}, - "pointOfInterestStatus": [
- {
- "pointOfInterestId": "string",
- "recordedEntries": [
- {
- "entryDateTime": "string",
- "exitDateTime": "string"
}
], - "totalDwellTime": 0
}
], - "sensorHistories": [
- {
- "readings": [
- {
- "utcTimestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "sensor": {
- "identifier": {
- "type": "TEMPERATURE",
- "value": "string"
}, - "max": 0,
- "min": 0,
- "target": 0
}
}
], - "shipment": {
- "apiConfiguration": {
- "fallBackToDefaultAccountGroup": true,
- "webhookEndpointConfigName": "string",
- "enableIntelligentMatching": true
}, - "attributes": [
- {
- "name": "string",
- "predefined": true,
- "value": "string",
- "values": [
- "string"
]
}
], - "capacityProviderAccountGroup": {
- "code": "string",
- "accounts": [
- {
- "code": "string"
}
]
}, - "carrierIdentifier": {
- "type": "SCAC",
- "value": "string"
}, - "equipmentIdentifierChanges": [
- {
- "timestamp": "string",
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}
], - "equipmentIdentifiers": [
- {
- "shouldDelete": true,
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}
], - "id": 0,
- "idleDuration": 0,
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "pointsOfInterest": [
- {
- "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "location": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}
}, - "locationIdentifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "pointOfInterestDescription": "string",
- "pointOfInterestId": "string",
- "pointOfInterestName": "string",
- "pointOfInterestType": "GENERAL",
- "shouldDelete": true
}
], - "sensors": [
- {
- "identifier": {
- "type": "TEMPERATURE",
- "value": "string"
}, - "max": 0,
- "min": 0,
- "target": 0
}
], - "shipmentDetails": {
- "lineItems": [
- {
- "commodityCode": "string",
- "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}, - "deliveryStopNumber": 0,
- "description": "string",
- "freightClass": "50",
- "handlingUnitPackageType": "PLT",
- "handlingUnitQuantity": 0,
- "involvedParties": [
- {
- "partyIdentifiers": [
- null
]
}
], - "itemIdentifiers": [
- {
- "type": "PURCHASE_ORDER",
- "value": "string"
}
], - "itemPackageType": "BAG",
- "itemQuantity": 0,
- "monetaryValue": {
- "currency": "USD",
- "amount": 0
}, - "pickupStopNumber": 0,
- "subLineItems": [
- {
- "commodityCode": "string",
- "contact": {
- "companyName": null,
- "contactName": null,
- "phoneNumber": null,
- "phoneNumberCountryCode": null,
- "phoneNumber2": null,
- "phoneNumber2CountryCode": null,
- "email": null,
- "faxNumber": null,
- "faxNumberCountryCode": null
}, - "description": "string",
- "freightClass": "50",
- "involvedParties": [
- null
], - "itemIdentifiers": [
- null
], - "itemPackageType": "BAG",
- "itemQuantity": 0,
- "monetaryValue": {
- "currency": null,
- "amount": null
}, - "totalWeight": {
- "weight": null,
- "weightUnit": null
}
}
], - "totalWeight": {
- "weight": 0,
- "weightUnit": "LB"
}
}
]
}, - "shipmentIdentifiers": [
- {
- "type": "BILL_OF_LADING",
- "value": "string"
}
], - "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
- "shipmentStops": [
- {
- "stopNumber": 1,
- "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "additionalAppointmentWindows": [
- {
- "type": "STRATEGIC",
- "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "appointmentStatus": "PENDING",
- "identifiers": [
- {
- "type": null,
- "value": null
}
]
}
], - "location": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}
}, - "locationIdentifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "stopName": "string",
- "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "stopType": "PICKUP",
- "stopDescription": "string",
- "involvedParties": [
- {
- "partyIdentifiers": [
- {
- "type": null,
- "value": null
}
]
}
], - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "externalArrivalEstimate": {
- "source": "SHIPPER",
- "dateTime": "2019-08-24T14:15:22Z"
}
}
], - "shippingDetails": {
- "multipleDrivers": true,
- "truckDetails": {
- "truckDimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unitOfMeasure": "IN"
}, - "weight": 0,
- "weightUnitOfMeasure": "LB",
- "truckType": "AUTO_CARRIER"
}, - "hazmatDetails": {
- "hazardClasses": [
- "string"
]
}
}, - "trackingDetails": [
- {
- "equipmentIdentifier": {
- "shouldDelete": true,
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}, - "equipmentIdentifierSource": "CUSTOMER",
- "trackingType": "MOBILE_PHONE"
}
]
}, - "statusUpdates": [
- {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "statusCode": "DISPATCHED",
- "statusReason": {
- "code": "PENDING_TRACKING_METHOD",
- "description": "string"
}, - "stopNumber": 0,
- "timestamp": "string"
}
]
}