Skip to content

Manifest webhooks are triggered by events related to manifests.

Overview

For manifest webhooks:

  • category: MANIFEST
  • triggerName: One of the available manifest events (see below)
  • payload: Contains the updated manifest data

For complete webhook structure and field descriptions, see Webhooks.

Available Events

  • MANIFEST_MODIFICATION - Triggered when manifest is modified (created, updated, or deleted)
  • MANIFEST_STATUS_CHANGE - Triggered when manifest status changes
  • MANIFEST_ASSET_DISPATCH_STATUS_CHANGE - Triggered when manifest asset dispatch status changes

Event Details

1. Manifest Modification Event

Trigger: MANIFEST_MODIFICATION

Fired when a manifest is created, updated, or deleted.

{
    "category": "MANIFEST",
    "webhookUuid": "a1c3e5f7-9b2d-4e6a-8c1f-3d5b7a9c1e02",
    "eventIdentifier": "b6b7f647-5a7b-442c-b7c6-9f5e78ae1d77",
    "triggerName": "MANIFEST_MODIFICATION",
    "triggerTime": 1756641334252,
    "entityExternalId": "Small",
    "entityUuid": "ea1a1775-e9a4-4211-ae8d-1b3a6511de2a",
    "payload": {
        "uuid": "ea1a1775-e9a4-4211-ae8d-1b3a6511de2a",
        "createDate": 1749649124552,
        "updateDate": 1756289187591,
        "externalIdentifier": "Small",
        "manifestStatus": "IN_PROGRESS",
        "activateDate": 1756289187555,
        "tracksCount": 1,
        "gate": {
            "uuid": "c3506ae0-0ab1-4212-97ad-547357ef67d7",
            "name": "SPB Jetson new"
        },
        "deleted": false,
        "loadingControl": [
            {
                "uuid": "90a38c21-8564-4a4a-ba59-dfa9c92042a3",
                "createDate": 1756289187566,
                "updateDate": 1756424183348,
                "track": {
                    "uuid": "86c8185d-d448-45cf-acfc-4f0510b5817f",
                    "trackCode": "000-125",
                    "wmsId": "wms-12345",
                    "status": "ACTIVE"
                },
                "trackIdentifier": "wms-12345",
                "loadedDate": 1756424183192,
                "loadingStatus": "LOADED"
            },
            {
                "uuid": "f907c4a7-0a57-4340-8ee8-6a4343284746",
                "createDate": 1756289223562,
                "updateDate": 1756289223562,
                "track": {
                    "uuid": "39a64455-9ea9-4f74-8ef0-971ee16d35eb",
                    "trackCode": "000-130",
                    "wmsId": "local-33121364151",
                    "status": "ACTIVE"
                },
                "trackIdentifier": "local-33121364151",
                "markerValue": "33121434156",
                "loadedDate": 1756289223031,
                "loadingStatus": "WRONGLY_LOADED"
            }
        ],
        "assets": [
            {
                "uuid": "f7ac3895-f75e-4429-b973-775307597a60",
                "createDate": 1749649124557,
                "updateDate": 1749649124557,
                "trackIdentifier": "wms-12345",
                "track": {
                    "uuid": "86c8185d-d448-45cf-acfc-4f0510b5817f",
                    "trackCode": "000-125",
                    "wmsId": "wms-12345",
                    "status": "ACTIVE"
                },
                "loadingStatus": "LOADED"
            }
        ]
    }
}

2. Manifest Status Change Event

Trigger: MANIFEST_STATUS_CHANGE

Fired when manifest status changes between PLANNED, IN_PROGRESS, COMPLETED, and CANCELLED states.

Payload structure is identical to manifest modification event, with manifestStatus reflecting the new status.

3. Manifest Asset Dispatch Status Change Event

Trigger: MANIFEST_ASSET_DISPATCH_STATUS_CHANGE

Fired when dispatch status of assets within a manifest changes.

Payload structure follows the same format, with the assets array containing updated information.

Payload Structure

For webhook header fields (category, eventIdentifier, triggerName, triggerTime, entityExternalId, entityUuid), see Webhooks.

Manifest Payload Fields

FieldTypeDescription
uuidStringManifest UUID
createDateLongUnix timestamp when manifest was created
updateDateLongUnix timestamp when manifest was last updated
externalIdentifierStringExternal system identifier
manifestStatusStringCurrent status (PLANNED, IN_PROGRESS, COMPLETED, CANCELLED)
activateDateLongUnix timestamp when manifest was activated (only for IN_PROGRESS status)
tracksCountIntegerNumber of tracks in the manifest
gateObjectGate information (uuid, name)
deletedBooleanWhether the manifest is marked as deleted
loadingControlArrayLoading control objects (only for IN_PROGRESS status, includes valid and invalid loadings)
assetsArrayAsset objects in the manifest

Loading Control Object

FieldTypeDescription
uuidStringLoading control UUID
createDateLongUnix timestamp when loading control was created
updateDateLongUnix timestamp when loading control was last updated
trackObjectTrack information object
trackIdentifierStringUnique identifier for the track
loadedDateLongUnix timestamp when the track was loaded
loadingStatusStringCurrent loading status (LOADED, WRONGLY_LOADED, etc.)
markerValueStringOptional marker value for tracking (may be null)

Asset Object

FieldTypeDescription
uuidStringAsset UUID
createDateLongUnix timestamp when asset was created
updateDateLongUnix timestamp when asset was last updated
trackIdentifierStringUnique identifier for the track
trackObjectTrack information object
loadingStatusStringCurrent loading status (NOT_LOADED, LOADED, etc.)

Track Object

FieldTypeDescription
uuidStringTrack UUID
trackCodeStringTrack code identifier
wmsIdStringWMS system identifier
statusStringTrack status (ACTIVE, INACTIVE, etc.)