This operation describes the payload that our service will send to your webhook endpoint.
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 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
Array of objects (TrackedShipmentEvent) All events that occurred for this shipment. Will always be in ascending order by the date the event occurred. | |
Array of objects (TrackedShipmentPosition) Locations where this shipment has been recorded. Data may be down-sampled. Will always be in ascending order by the date that the shipment was at that position. | |
object (SharingContext) This model is populated when the data is shared across tenants, it conditionally describes which tenant(s) are involved with the shared data using tenant name and tenant UUID. | |
object (TrackedShipment) Shipment tracking model used to initiate a shipment. | |
Array of objects (TrackedShipmentState) All states that the shipment was or currently is in. Order is not guaranteed. |
OK
Created
Accepted
No Content
Invalid payload or other client error
Server error
{- "events": [
- {
- "dateTime": "string",
- "dateTimes": [
- {
- "type": "UNKNOWN",
- "dateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "lastModifiedDateTime": "2019-08-24T14:15:22Z",
- "source": "UNKNOWN",
- "sourceIdentifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "selected": true,
- "sequence": 0
}
], - "description": "string",
- "estimateDateTime": "string",
- "estimateLastCalculatedDateTime": "string",
- "plannedDateTime": "string",
- "plannedEndDateTime": "string",
- "receivedDateTime": "string",
- "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352",
- "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43",
- "type": "UNKNOWN"
}
], - "positions": [
- {
- "dateTime": "string",
- "latitude": 0,
- "longitude": 0,
- "receivedDateTime": "string",
- "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352"
}
], - "sharingContext": {
- "dataOriginators": [
- {
- "tenantUuid": "e46705ba-31a8-4f12-b6d3-f41ec1d77a9a",
- "tenantName": "string",
- "tenantId": 0
}
], - "recipients": [
- {
- "tenantUuid": "e46705ba-31a8-4f12-b6d3-f41ec1d77a9a",
- "tenantName": "string",
- "tenantId": 0
}
]
}, - "shipment": {
- "accessGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "createdDateTime": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "lastModifiedDateTime": "string",
- "relatedShipments": [
- {
- "accessGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "createdDateTime": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "lastModifiedDateTime": "string",
- "shipmentShareLink": "string"
}
], - "routeInfo": {
- "routeSegments": [
- {
- "emissions": {
- "co2EmissionIntensity": {
- "value": 0,
- "unit": "KG_PER_KM"
}, - "distance": {
- "value": 0,
- "unit": "FT"
}, - "totalCO2Emissions": {
- "value": 0,
- "unit": "LB"
}
}, - "fromStopId": "257296aa-4e11-4168-b6a7-981b8b94815b",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "toStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56",
- "transportationMode": "AIR"
}
], - "stops": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "UNKNOWN",
- "location": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": null,
- "value": null
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- null
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "coordinates": {
- "latitude": -90,
- "longitude": -180
}, - "timeZone": "string"
}
}
]
}, - "shipmentShareLink": "string"
}, - "states": [
- {
- "endDateTime": "string",
- "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352",
- "startDateTime": "string",
- "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43",
- "type": "UNKNOWN"
}
]
}