Webhook Events
Events Xemelgo delivers to your registered endpoint as an HTTP POST. To start receiving them and verify signatures, see Webhooks.
Item events use trackers for tracker details. trackerSerial remains as a legacy primary serial. The intermediary trackerSerials response field has been removed; use trackers[].serial instead. When no tracker is associated, trackers is null. Each tracker includes its serial, encoding format, custom properties, and attachment date when available.
Event envelope
Every event is delivered as this JSON envelope. The data object varies by topic (below).
Every request also includes the xemelgo-delivery-id header. It matches the envelope id and remains available when a webhook is configured to receive the payload directly.
| Field | Type | Description |
|---|
id | string | Unique delivery identifier. It remains unchanged across retries and can be used for deduplication. |
eventTimestamp | integer | Event time as epoch milliseconds. |
topic | string | The event type (one of the topics below). |
data | object | Event-specific payload; see the topic. |
Asset
asset.bulk_update
Sent when an asset bulk-update operation completes. The payload contains the updated assets.
Payload (data)
| Field | Type |
|---|
assets | object[] |
creationDate | integer |
customProperties | object (free-form) · nullable |
submittedAtLocationId | string |
submittedByUser | object |
uuid | string |
data.assets
| Field | Type |
|---|
id | string |
itemUpdate | object (free-form) · nullable |
location | object · nullable |
previousFieldValues | object (free-form) · nullable |
uom | string · nullable |
uuid | string |
data.assets.location
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.bulk_update",
"data": {
"assets": [
{
"id": "A-1",
"itemUpdate": {
"quantityAdded": 1
},
"location": {
"id": "L-1"
},
"previousFieldValues": {},
"uom": "EA",
"uuid": "11111111-1111-4111-8111-111111111111"
}
],
"creationDate": 1765420060123,
"customProperties": null,
"submittedAtLocationId": "1-Z",
"submittedByUser": {
"alias": "person1",
"customProperties": {},
"firstName": "door",
"lastName": "dash"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
asset.created
Sent when a new asset is created. The payload contains the full asset, including its type and any custom properties.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
dueDate | integer · nullable |
id | string |
images | string[] |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
name | string · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
type | object · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
data.type
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.created",
"data": {
"comments": "Asset Create 1 Comments",
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"assetTs": "Asset 12345"
},
"description": "Asset Create 1 Description",
"dueDate": 1765420060189,
"id": "ASSET-CREATE-1",
"images": [
"img1.jpg"
],
"lastDetectedAtLocation": null,
"lastUpdatedDate": 1765420060123,
"location": null,
"name": "Asset Create 1",
"state": "incoming",
"trackerSerial": "TRACKER-ASSET-CREATE-1",
"type": {
"creationDate": 1765420060123,
"customProperties": {
"assetTypeTs": null
},
"description": null,
"id": "TYPE-1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": null,
"number": null,
"quantity": null,
"unit": null
},
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-ASSET-CREATE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
asset.cycle_count
Sent when an asset cycle count is submitted. Provides item-level detail and aggregate counts per asset type.
Payload (data)
| Field | Type |
|---|
assetTypes | object[] |
creationDate | integer |
customerId | string · nullable |
location | object · nullable |
locationId | string · nullable |
submittedByUser | object |
uuid | string |
data.assetTypes
| Field | Type |
|---|
addedCount | integer |
assets | object[] |
detectedCount | integer |
foundCount | integer |
id | string |
missingCount | integer |
movedCount | integer |
name | string · nullable |
noActionCount | integer |
removedCount | integer |
totalCount | integer |
data.assetTypes.assets
| Field | Type |
|---|
action | string |
id | string |
trackerSerial | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.cycle_count",
"data": {
"assetTypes": [
{
"addedCount": 0,
"assets": [
{
"action": "DETECTED",
"id": "Asset-1",
"trackerSerial": "vid-asset-1"
}
],
"detectedCount": 1,
"foundCount": 0,
"id": "TypeA",
"missingCount": 0,
"movedCount": 0,
"name": null,
"noActionCount": 0,
"removedCount": 0,
"totalCount": 1
}
],
"creationDate": 1765420060123,
"customerId": null,
"location": {
"categoryId": "Zone",
"customProperties": {},
"customerId": null,
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": null,
"roleId": null
},
"locationId": "1-Z",
"submittedByUser": {
"alias": "person1",
"customProperties": {},
"firstName": "door",
"lastName": "dash"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
asset.cycle_count.counts
Sent when an asset cycle count is submitted. Provides aggregate counts per asset type only (no item-level detail).
Payload (data)
| Field | Type |
|---|
assetTypes | object[] |
creationDate | integer |
customerId | string · nullable |
location | object · nullable |
locationId | string · nullable |
submittedByUser | object |
uuid | string |
data.assetTypes
| Field | Type |
|---|
addedCount | integer |
detectedCount | integer |
foundCount | integer |
id | string |
missingCount | integer |
movedCount | integer |
name | string · nullable |
noActionCount | integer |
removedCount | integer |
totalCount | integer |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.cycle_count.counts",
"data": {
"assetTypes": [
{
"addedCount": 0,
"detectedCount": 1,
"foundCount": 0,
"id": "TypeA",
"missingCount": 0,
"movedCount": 0,
"name": null,
"noActionCount": 0,
"removedCount": 0,
"totalCount": 1
}
],
"creationDate": 1765420060123,
"customerId": null,
"location": {
"categoryId": "Zone",
"customProperties": {},
"customerId": null,
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": null,
"roleId": null
},
"locationId": "1-Z",
"submittedByUser": {
"alias": "person1",
"customProperties": {},
"firstName": "door",
"lastName": "dash"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
asset.cycle_count.submitted.counts (beta)
Sent when an asset Cycle Count result is accepted. Provides submitted evidence and aggregate item counts per asset type; it does not confirm that asset reconciliation has completed.
Payload (data)
INLINE delivery
| Field | Type |
|---|
assetTypes | object[] |
delivery | string |
entries | object[] |
id | string |
name | string |
submittedAt | integer |
submittedBy | object |
summary | object |
data.assetTypes
| Field | Type |
|---|
addedCount | integer |
assetType | object |
detectedCount | integer |
foundCount | integer |
location | object · nullable |
missingCount | integer |
movedCount | integer |
noActionCount | integer |
removedCount | integer |
totalCount | integer |
data.assetTypes.assetType
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
number | string |
unit | string |
data.assetTypes.location
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
REPORT delivery
| Field | Type |
|---|
delivery | string |
id | string |
name | string |
reportRun | object |
submittedAt | integer |
submittedBy | object |
summary | object |
data.reportRun
| Field | Type |
|---|
completionDate | integer |
downloadUrl | string |
downloadUrlExpiresAt | integer |
id | string |
outputFormat | string |
reportType | string |
status | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.cycle_count.submitted.counts",
"data": {
"id": "CC-2026-002",
"name": "Tool crib count",
"submittedAt": 1765572200000,
"summary": {
"entryCount": 1,
"countedEntryCount": 1,
"notCountedEntryCount": 0,
"unevaluatedEntryCount": 0,
"expectedItemCount": 1,
"countedExpectedItemCount": 1,
"countedUnexpectedItemCount": 0
},
"delivery": "INLINE",
"entries": [
{
"id": "expectation-002",
"location": {
"id": "TOOL-CRIB",
"name": "Tool Crib"
},
"assetType": {
"id": "TORQUE-WRENCH",
"name": "Torque Wrench"
},
"expectedQuantity": 1,
"countedQuantity": 1,
"status": "COUNTED"
}
],
"assetTypes": [
{
"location": {
"id": "TOOL-CRIB",
"name": "Tool Crib"
},
"assetType": {
"id": "TORQUE-WRENCH",
"name": "Torque Wrench"
},
"totalCount": 1,
"detectedCount": 1,
"foundCount": 0,
"missingCount": 0,
"movedCount": 0,
"addedCount": 0,
"removedCount": 0,
"noActionCount": 0
}
]
}
}
asset.cycle_count.submitted.items (beta)
Sent when an asset Cycle Count result is accepted. Provides submitted evidence, aggregate item counts, and individual item evidence; it does not confirm that asset reconciliation has completed.
Payload (data)
INLINE delivery
| Field | Type |
|---|
assetTypes | object[] |
assets | object[] |
delivery | string |
entries | object[] |
id | string |
name | string |
submittedAt | integer |
submittedBy | object |
summary | object |
data.assetTypes
| Field | Type |
|---|
addedCount | integer |
assetType | object |
detectedCount | integer |
foundCount | integer |
location | object · nullable |
missingCount | integer |
movedCount | integer |
noActionCount | integer |
removedCount | integer |
totalCount | integer |
data.assetTypes.assetType
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
number | string |
unit | string |
data.assetTypes.location
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
data.assets
| Field | Type |
|---|
action | string |
assetTypeId | string |
countLocationId | string |
countedQuantity | number |
customProperties | object (free-form) |
errors | string[] |
expected | boolean |
id | string |
note | string |
outcome | string |
reportFields | object (free-form) |
trackerSerial | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
REPORT delivery
| Field | Type |
|---|
delivery | string |
id | string |
name | string |
reportRun | object |
submittedAt | integer |
submittedBy | object |
summary | object |
data.reportRun
| Field | Type |
|---|
completionDate | integer |
downloadUrl | string |
downloadUrlExpiresAt | integer |
id | string |
outputFormat | string |
reportType | string |
status | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.cycle_count.submitted.items",
"data": {
"id": "CC-2026-002",
"name": "Tool crib count",
"submittedAt": 1765572200000,
"summary": {
"entryCount": 1,
"countedEntryCount": 1,
"notCountedEntryCount": 0,
"unevaluatedEntryCount": 0,
"expectedItemCount": 1,
"countedExpectedItemCount": 1,
"countedUnexpectedItemCount": 0
},
"delivery": "INLINE",
"entries": [
{
"id": "expectation-002",
"location": {
"id": "TOOL-CRIB",
"name": "Tool Crib"
},
"assetType": {
"id": "TORQUE-WRENCH",
"name": "Torque Wrench"
},
"expectedQuantity": 1,
"countedQuantity": 1,
"status": "COUNTED"
}
],
"assetTypes": [
{
"location": {
"id": "TOOL-CRIB",
"name": "Tool Crib"
},
"assetType": {
"id": "TORQUE-WRENCH",
"name": "Torque Wrench"
},
"totalCount": 1,
"detectedCount": 1,
"foundCount": 0,
"missingCount": 0,
"movedCount": 0,
"addedCount": 0,
"removedCount": 0,
"noActionCount": 0
}
],
"assets": [
{
"id": "ASSET-1001",
"outcome": "ACCEPTED",
"action": "DETECTED",
"expected": true,
"countLocationId": "TOOL-CRIB",
"assetTypeId": "TORQUE-WRENCH",
"trackerSerial": "E280117000000002",
"customProperties": {
"calibrationStatus": "CURRENT"
}
}
]
}
}
asset.deleted
Sent when assets are deleted. The payload contains the deleted assets.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
dueDate | integer · nullable |
id | string |
images | string[] |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
name | string · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
type | object · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
data.type
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.deleted",
"data": {
"comments": "Asset 1 Comments",
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"assetTs": "Asset 12345"
},
"description": "Asset 1 Description",
"dueDate": 1765420060189,
"id": "ASSET-1",
"images": [
"img1.jpg"
],
"lastDetectedAtLocation": {
"categoryId": "Dock Door",
"customProperties": {},
"customerId": null,
"description": "At dock door 1",
"id": "DOCK-1",
"name": "Dock Door 1",
"parentLocationId": null,
"roleId": null
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Dock Door",
"customProperties": {},
"customerId": null,
"description": "At dock door 1",
"id": "DOCK-1",
"name": "Dock Door 1",
"parentLocationId": null,
"roleId": null
},
"name": "Asset 1",
"state": "incoming",
"trackerSerial": null,
"type": {
"creationDate": 1765420060123,
"customProperties": {
"assetTypeTs": null
},
"description": null,
"id": "TYPE-1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": null,
"number": null,
"quantity": null,
"unit": null
},
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": null
}
}
asset.moved
Sent when a tracked asset is detected at or moved to a new location. The payload contains the full asset, including its current and last-detected locations.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
dueDate | integer · nullable |
id | string |
images | string[] |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
name | string · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
type | object · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
data.type
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "asset.moved",
"data": {
"comments": "Asset Move 1 Comments",
"containerId": "CONTAINER-A1",
"creationDate": 1765420060123,
"customProperties": {
"assetTs": "Asset 12345"
},
"description": "Asset Move 1 Description",
"dueDate": 1765420060189,
"id": "ASSET-MOVE-1",
"images": [
"img1.jpg"
],
"lastDetectedAtLocation": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": "stockroom"
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": "stockroom"
},
"name": "Asset Move 1",
"state": "onhand",
"trackerSerial": "TRACKER-ASSET-MOVE-1",
"type": {
"creationDate": 1765420060123,
"customProperties": {
"assetTypeTs": null
},
"description": null,
"id": "TYPE-1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": null,
"number": null,
"quantity": null,
"unit": null
},
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-ASSET-MOVE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
Inventory
inventory.audit
Sent when an inventory audit is submitted. Provides item-level detail and aggregate counts per inventory part.
Payload (data)
| Field | Type |
|---|
creationDate | integer |
customerId | string · nullable |
inventoryParts | object[] |
location | object · nullable |
locationId | string · nullable |
submittedByUser | object |
uuid | string |
data.inventoryParts
| Field | Type |
|---|
automaticallyAddedCount | integer |
customerOnHandCount | integer |
id | string |
inventory | object[] |
manuallyAddedCount | integer |
name | string · nullable |
removedCount | integer |
scannedCount | integer |
totalCount | integer |
data.inventoryParts.inventory
| Field | Type |
|---|
action | string |
expirationDate | integer · nullable |
isConsumed | boolean · nullable |
lotNumber | string |
trackerSerial | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.audit",
"data": {
"creationDate": 1765420060123,
"customerId": null,
"inventoryParts": [
{
"automaticallyAddedCount": 1,
"customerOnHandCount": 1,
"id": "audit-itemType1",
"inventory": [
{
"action": "MANUALLY ADDED",
"expirationDate": 1766187135000,
"isConsumed": false,
"lotNumber": "LOT-001",
"trackerSerial": "AUDIT-VID-001"
},
{
"action": "SCANNED",
"expirationDate": 1766187135000,
"isConsumed": false,
"lotNumber": "LOT-002",
"trackerSerial": "AUDIT-VID-002"
},
{
"action": "AUTOMATICALLY ADDED",
"isConsumed": false,
"lotNumber": "LOT-003",
"trackerSerial": "AUDIT-VID-003"
},
{
"action": "REMOVED",
"isConsumed": false,
"lotNumber": "LOT-004",
"trackerSerial": "AUDIT-VID-004"
},
{
"action": "CUSTOMER ONHAND",
"isConsumed": false,
"lotNumber": "LOT-005",
"trackerSerial": "AUDIT-VID-005"
}
],
"manuallyAddedCount": 1,
"name": null,
"removedCount": 1,
"scannedCount": 1,
"totalCount": 5
}
],
"location": {
"categoryId": "Stock Room",
"customProperties": {},
"customerId": null,
"description": "Audit Stock Room 1",
"id": "AUDIT-R-STOCKRM1",
"name": "Audit Stock Room 1",
"parentLocationId": "AUDIT-1-Z",
"roleId": null
},
"locationId": "AUDIT-R-STOCKRM1",
"submittedByUser": {
"alias": "audit-person1",
"customProperties": {
"department": "Operations"
},
"firstName": "User",
"lastName": "Audit"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
inventory.audit.counts
Sent when an inventory audit is submitted. Provides aggregate counts per inventory part only (no item-level detail).
Payload (data)
| Field | Type |
|---|
creationDate | integer |
customerId | string · nullable |
inventoryParts | object[] |
location | object · nullable |
locationId | string · nullable |
submittedByUser | object |
uuid | string |
data.inventoryParts
| Field | Type |
|---|
automaticallyAddedCount | integer |
customerOnHandCount | integer |
id | string |
manuallyAddedCount | integer |
name | string · nullable |
removedCount | integer |
scannedCount | integer |
totalCount | integer |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.audit.counts",
"data": {
"creationDate": 1765420060123,
"customerId": null,
"inventoryParts": [
{
"automaticallyAddedCount": 1,
"customerOnHandCount": 1,
"id": "audit-itemType1",
"manuallyAddedCount": 1,
"name": null,
"removedCount": 1,
"scannedCount": 1,
"totalCount": 5
}
],
"location": {
"categoryId": "Stock Room",
"customProperties": {},
"customerId": null,
"description": "Audit Stock Room 1",
"id": "AUDIT-R-STOCKRM1",
"name": "Audit Stock Room 1",
"parentLocationId": "AUDIT-1-Z",
"roleId": null
},
"locationId": "AUDIT-R-STOCKRM1",
"submittedByUser": {
"alias": "audit-person1",
"customProperties": {
"department": "Operations"
},
"firstName": "User",
"lastName": "Audit"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
inventory.bulk_update
Sent when an inventory bulk-update operation completes. The payload contains the updated inventory items.
Payload (data)
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
inventory | object[] |
submittedAtLocationId | string |
submittedByUser | object |
uuid | string |
data.inventory
| Field | Type |
|---|
id | string |
itemUpdate | object (free-form) · nullable |
location | object · nullable |
previousFieldValues | object (free-form) · nullable |
uom | string · nullable |
uuid | string |
data.inventory.location
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.bulk_update",
"data": {
"creationDate": 1765420060123,
"customProperties": null,
"inventory": [
{
"id": "ITEM-1",
"itemUpdate": {
"quantityAdded": 5
},
"location": {
"id": "1-Z"
},
"previousFieldValues": {},
"uom": "EA",
"uuid": "11111111-1111-4111-8111-111111111111"
}
],
"submittedAtLocationId": "1-Z",
"submittedByUser": {
"alias": "person1",
"customProperties": {},
"firstName": "door",
"lastName": "dash"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
inventory.consumed
Sent when an inventory item is marked as consumed. The payload contains the full inventory item with its consumed state and date.
Payload (data)
| Field | Type |
|---|
associatedPersons | object[] |
comments | string · nullable |
consumedDate | integer · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
expirationDate | integer · nullable |
id | string |
images | string[] |
isConsumed | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
lotNumber | string |
name | string · nullable |
part | object |
quantity | integer · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.associatedPersons
| Field | Type |
|---|
alias | string |
customProperties | object (free-form) · nullable |
firstName | string |
lastName | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.part
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.consumed",
"data": {
"associatedPersons": [
{
"alias": "consume-person-1",
"customProperties": {},
"firstName": "Consume",
"lastName": "Person"
},
{
"alias": "consume-person-2",
"customProperties": {},
"firstName": "Consume",
"lastName": "Person2"
}
],
"comments": null,
"consumedDate": 1765420060123,
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"inventoryTs": null
},
"description": "",
"expirationDate": null,
"id": "INV-TRACKER-001",
"images": [],
"isConsumed": true,
"lastDetectedAtLocation": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": null
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": null
},
"lotNumber": "",
"name": "",
"part": {
"creationDate": 1765420060123,
"customProperties": {
"inventoryPartTs": "type1 custom field"
},
"description": null,
"id": "type1",
"imagePath": "parts/type1.jpg",
"images": [],
"lastUpdatedDate": 1765420060123,
"name": "type1-name",
"number": null,
"quantity": null,
"unit": "EA"
},
"quantity": null,
"state": "onhand",
"trackerSerial": "INV-TRACKER-001",
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "INV-TRACKER-001",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
inventory.created
Sent when a new inventory item is created. The payload contains the full inventory item, including its part and any custom properties.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
consumedDate | integer · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
expirationDate | integer · nullable |
id | string |
images | string[] |
isConsumed | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
lotNumber | string |
name | string · nullable |
part | object |
quantity | integer · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.part
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.created",
"data": {
"comments": "Inventory Create 1 Comments",
"consumedDate": null,
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"inventoryTs": "Inventory 12345"
},
"description": "Inventory Create 1 Description",
"expirationDate": 1765420060189,
"id": "INVENTORY-CREATE-1",
"images": [
"img1.jpg"
],
"isConsumed": null,
"lastDetectedAtLocation": null,
"lastUpdatedDate": 1765420060123,
"location": null,
"lotNumber": "32",
"name": "Inventory Create 1",
"part": {
"creationDate": 1765420060123,
"customProperties": {
"inventoryPartTs": null
},
"description": null,
"id": "TYPE-1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": null,
"number": null,
"quantity": null,
"unit": null
},
"quantity": 13,
"state": "incoming",
"trackerSerial": "TRACKER-INV-CREATE-1",
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-INV-CREATE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
inventory.cycle_count
Sent when an inventory cycle count is submitted. Provides item-level detail and aggregate counts per inventory part.
Payload (data)
| Field | Type |
|---|
creationDate | integer |
customerId | string · nullable |
inventoryParts | object[] |
location | object · nullable |
locationId | string · nullable |
submittedByUser | object |
uuid | string |
data.inventoryParts
| Field | Type |
|---|
addedCount | integer |
detectedCount | integer |
foundCount | integer |
id | string |
inventory | object[] |
missingCount | integer |
movedCount | integer |
name | string · nullable |
noActionCount | integer |
removedCount | integer |
totalCount | integer |
data.inventoryParts.inventory
| Field | Type |
|---|
action | string |
id | string |
trackerSerial | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.cycle_count",
"data": {
"creationDate": 1765420060123,
"customerId": null,
"inventoryParts": [
{
"addedCount": 0,
"detectedCount": 1,
"foundCount": 0,
"id": "Desktop",
"inventory": [
{
"action": "DETECTED",
"id": "728",
"trackerSerial": "012417377714585"
},
{
"action": "MISSING",
"id": "identifier2",
"trackerSerial": "vid2"
}
],
"missingCount": 1,
"movedCount": 0,
"name": null,
"noActionCount": 0,
"removedCount": 0,
"totalCount": 2
},
{
"addedCount": 0,
"detectedCount": 1,
"foundCount": 0,
"id": "Laptop",
"inventory": [
{
"action": "DETECTED",
"id": "identifier3",
"trackerSerial": "vid3"
}
],
"missingCount": 0,
"movedCount": 0,
"name": null,
"noActionCount": 0,
"removedCount": 0,
"totalCount": 1
}
],
"location": {
"categoryId": "Zone",
"customProperties": {},
"customerId": null,
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": null,
"roleId": null
},
"locationId": "1-Z",
"submittedByUser": {
"alias": "person1",
"customProperties": {},
"firstName": "door",
"lastName": "dash"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
inventory.cycle_count.counts
Sent when an inventory cycle count is submitted. Provides aggregate counts per inventory part only (no item-level detail).
Payload (data)
| Field | Type |
|---|
creationDate | integer |
customerId | string · nullable |
inventoryParts | object[] |
location | object · nullable |
locationId | string · nullable |
submittedByUser | object |
uuid | string |
data.inventoryParts
| Field | Type |
|---|
addedCount | integer |
detectedCount | integer |
foundCount | integer |
id | string |
missingCount | integer |
movedCount | integer |
name | string · nullable |
noActionCount | integer |
removedCount | integer |
totalCount | integer |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.submittedByUser
| Field | Type |
|---|
alias | string · nullable |
customProperties | object (free-form) · nullable |
firstName | string · nullable |
lastName | string · nullable |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.cycle_count.counts",
"data": {
"creationDate": 1765420060123,
"customerId": null,
"inventoryParts": [
{
"addedCount": 0,
"detectedCount": 1,
"foundCount": 0,
"id": "TypeI",
"missingCount": 0,
"movedCount": 0,
"name": null,
"noActionCount": 0,
"removedCount": 0,
"totalCount": 1
}
],
"location": {
"categoryId": "Zone",
"customProperties": {},
"customerId": null,
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": null,
"roleId": null
},
"locationId": "1-Z",
"submittedByUser": {
"alias": "person1",
"customProperties": {},
"firstName": "door",
"lastName": "dash"
},
"uuid": "11111111-1111-4111-8111-111111111111"
}
}
inventory.cycle_count.submitted.counts (beta)
Sent when an inventory Cycle Count result is accepted. Provides submitted evidence and aggregate item counts per inventory part; it does not confirm that inventory reconciliation has completed.
Payload (data)
INLINE delivery
| Field | Type |
|---|
delivery | string |
entries | object[] |
id | string |
inventoryParts | object[] |
name | string |
submittedAt | integer |
submittedBy | object |
summary | object |
data.inventoryParts
| Field | Type |
|---|
addedCount | integer |
detectedCount | integer |
foundCount | integer |
location | object · nullable |
missingCount | integer |
movedCount | integer |
noActionCount | integer |
part | object |
removedCount | integer |
totalCount | integer |
data.inventoryParts.location
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
data.inventoryParts.part
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
number | string |
unit | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
REPORT delivery
| Field | Type |
|---|
delivery | string |
id | string |
name | string |
reportRun | object |
submittedAt | integer |
submittedBy | object |
summary | object |
data.reportRun
| Field | Type |
|---|
completionDate | integer |
downloadUrl | string |
downloadUrlExpiresAt | integer |
id | string |
outputFormat | string |
reportType | string |
status | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.cycle_count.submitted.counts",
"data": {
"id": "CC-2026-001",
"name": "Warehouse A recount",
"submittedAt": 1765572200000,
"submittedBy": {
"id": "counter@example.com",
"firstName": "Casey",
"lastName": "Lee"
},
"summary": {
"entryCount": 1,
"countedEntryCount": 1,
"notCountedEntryCount": 0,
"unevaluatedEntryCount": 0,
"expectedItemCount": 2,
"countedExpectedItemCount": 2,
"countedUnexpectedItemCount": 0
},
"delivery": "INLINE",
"entries": [
{
"id": "expectation-001",
"location": {
"id": "A-01",
"name": "Bin A-01"
},
"part": {
"id": "530533",
"name": "Camouflage Face Paint",
"unit": "EA"
},
"expectedQuantity": 2,
"countedQuantity": 2,
"status": "COUNTED",
"customProperties": {
"receiptId": "37757394"
}
}
],
"inventoryParts": [
{
"location": {
"id": "A-01",
"name": "Bin A-01"
},
"part": {
"id": "530533",
"name": "Camouflage Face Paint",
"unit": "EA"
},
"totalCount": 2,
"detectedCount": 2,
"foundCount": 0,
"missingCount": 0,
"movedCount": 0,
"addedCount": 0,
"removedCount": 0,
"noActionCount": 0
}
]
}
}
inventory.cycle_count.submitted.items (beta)
Sent when an inventory Cycle Count result is accepted. Provides submitted evidence, aggregate item counts, and individual item evidence; it does not confirm that inventory reconciliation has completed.
Payload (data)
INLINE delivery
| Field | Type |
|---|
delivery | string |
entries | object[] |
id | string |
inventory | object[] |
inventoryParts | object[] |
name | string |
submittedAt | integer |
submittedBy | object |
summary | object |
data.inventory
| Field | Type |
|---|
action | string |
countLocationId | string |
countedQuantity | number |
customProperties | object (free-form) |
errors | string[] |
expected | boolean |
id | string |
note | string |
outcome | string |
partId | string |
reportFields | object (free-form) |
trackerSerial | string |
data.inventoryParts
| Field | Type |
|---|
addedCount | integer |
detectedCount | integer |
foundCount | integer |
location | object · nullable |
missingCount | integer |
movedCount | integer |
noActionCount | integer |
part | object |
removedCount | integer |
totalCount | integer |
data.inventoryParts.location
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
data.inventoryParts.part
| Field | Type |
|---|
customProperties | object (free-form) |
description | string |
id | string |
name | string |
number | string |
unit | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
REPORT delivery
| Field | Type |
|---|
delivery | string |
id | string |
name | string |
reportRun | object |
submittedAt | integer |
submittedBy | object |
summary | object |
data.reportRun
| Field | Type |
|---|
completionDate | integer |
downloadUrl | string |
downloadUrlExpiresAt | integer |
id | string |
outputFormat | string |
reportType | string |
status | string |
data.submittedBy
| Field | Type |
|---|
customProperties | object (free-form) |
firstName | string · nullable |
id | string |
lastName | string · nullable |
data.summary
| Field | Type |
|---|
countedEntryCount | integer |
countedExpectedItemCount | integer |
countedUnexpectedItemCount | integer |
entryCount | integer |
expectedItemCount | integer |
notCountedEntryCount | integer |
unevaluatedEntryCount | integer |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.cycle_count.submitted.items",
"data": {
"id": "CC-2026-001",
"name": "Warehouse A recount",
"submittedAt": 1765572200000,
"summary": {
"entryCount": 1,
"countedEntryCount": 1,
"notCountedEntryCount": 0,
"unevaluatedEntryCount": 0,
"expectedItemCount": 1,
"countedExpectedItemCount": 1,
"countedUnexpectedItemCount": 0
},
"delivery": "INLINE",
"entries": [
{
"id": "expectation-001",
"location": {
"id": "A-01",
"name": "Bin A-01"
},
"part": {
"id": "530533",
"name": "Camouflage Face Paint",
"unit": "EA"
},
"expectedQuantity": 1,
"countedQuantity": 1,
"status": "COUNTED",
"customProperties": {
"receiptId": "37757394"
}
}
],
"inventoryParts": [
{
"location": {
"id": "A-01",
"name": "Bin A-01"
},
"part": {
"id": "530533",
"name": "Camouflage Face Paint",
"unit": "EA"
},
"totalCount": 1,
"detectedCount": 1,
"foundCount": 0,
"missingCount": 0,
"movedCount": 0,
"addedCount": 0,
"removedCount": 0,
"noActionCount": 0
}
],
"inventory": [
{
"id": "INV-1001",
"outcome": "ACCEPTED",
"action": "DETECTED",
"expected": true,
"countLocationId": "A-01",
"partId": "530533",
"trackerSerial": "E280117000000001",
"customProperties": {
"ownerCompanyId": "SAIC"
},
"reportFields": {
"condition": "good"
}
}
]
}
}
inventory.deleted
Sent when inventory items are deleted. The payload contains the deleted inventory items.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
consumedDate | integer · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
expirationDate | integer · nullable |
id | string |
images | string[] |
isConsumed | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
lotNumber | string |
name | string · nullable |
part | object |
quantity | integer · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.part
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.deleted",
"data": {
"comments": "Inventory 1 Comments",
"consumedDate": null,
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"inventoryTs": "Inventory 12345"
},
"description": "Inventory 1 Description",
"expirationDate": 1765420060189,
"id": "INVENTORY-1",
"images": [
"img1.jpg"
],
"isConsumed": null,
"lastDetectedAtLocation": {
"categoryId": "Dock Door",
"customProperties": {},
"customerId": null,
"description": "At dock door 1",
"id": "DOCK-1",
"name": "Dock Door 1",
"parentLocationId": null,
"roleId": null
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Dock Door",
"customProperties": {},
"customerId": null,
"description": "At dock door 1",
"id": "DOCK-1",
"name": "Dock Door 1",
"parentLocationId": null,
"roleId": null
},
"lotNumber": "32",
"name": "Inventory 1",
"part": {
"creationDate": 1765420060123,
"customProperties": {
"inventoryPartTs": null
},
"description": null,
"id": "TYPE-1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": null,
"number": null,
"quantity": null,
"unit": null
},
"quantity": 13,
"state": "incoming",
"trackerSerial": null,
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": null
}
}
inventory.moved
Sent when an inventory item is detected at or moved to a new location. The payload contains the full inventory item, including its current and last-detected locations.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
consumedDate | integer · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
expirationDate | integer · nullable |
id | string |
images | string[] |
isConsumed | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
lotNumber | string |
name | string · nullable |
part | object |
quantity | integer · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.part
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.moved",
"data": {
"comments": "Item Move 1 Comments",
"consumedDate": null,
"containerId": "CONTAINER-A1",
"creationDate": 1765420060123,
"customProperties": {
"inventoryTs": "12345"
},
"description": "Item Move 1 Description",
"expirationDate": 1765420060189,
"id": "ITEM-MOVE-1",
"images": [
"img1.jpg"
],
"isConsumed": null,
"lastDetectedAtLocation": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": "stockroom"
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": "stockroom"
},
"lotNumber": "32",
"name": "Item Move 1",
"part": {
"creationDate": 1765420060123,
"customProperties": {
"inventoryPartTs": null
},
"description": null,
"id": "PART-1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": null,
"number": null,
"quantity": null,
"unit": null
},
"quantity": 13,
"state": "onhand",
"trackerSerial": "TRACKER-INV-MOVE-1",
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-INV-MOVE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
inventory.returned
Sent when a previously consumed inventory item is returned to stock. The payload contains the full inventory item with its restored state.
Payload (data)
| Field | Type |
|---|
associatedPersons | object[] |
comments | string · nullable |
consumedDate | integer · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
expirationDate | integer · nullable |
id | string |
images | string[] |
isConsumed | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
lotNumber | string |
name | string · nullable |
part | object |
quantity | integer · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.associatedPersons
| Field | Type |
|---|
alias | string |
customProperties | object (free-form) · nullable |
firstName | string |
lastName | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.part
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) · nullable |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "inventory.returned",
"data": {
"associatedPersons": [
{
"alias": "consume-person-1",
"customProperties": {},
"firstName": "Consume",
"lastName": "Person"
},
{
"alias": "consume-person-2",
"customProperties": {},
"firstName": "Consume",
"lastName": "Person2"
}
],
"comments": null,
"consumedDate": 1765420060123,
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"inventoryTs": null
},
"description": "",
"expirationDate": null,
"id": "INV-TRACKER-001",
"images": [],
"isConsumed": false,
"lastDetectedAtLocation": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": null
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": null
},
"lotNumber": "",
"name": "",
"part": {
"creationDate": 1765420060123,
"customProperties": {
"inventoryPartTs": "type1 custom field"
},
"description": null,
"id": "type1",
"imagePath": null,
"images": [],
"lastUpdatedDate": 1765420060123,
"name": "type1-name",
"number": null,
"quantity": null,
"unit": null
},
"quantity": null,
"state": "onhand",
"trackerSerial": "INV-TRACKER-001",
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "INV-TRACKER-001",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
Package
package.created
Sent when a new package is created. The payload contains the full package and any custom properties.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
id | string |
images | string[] |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
name | string · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "package.created",
"data": {
"comments": "Package Create 1 Comments",
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"packageTs": "Package 12345"
},
"description": "Package Create 1 Description",
"id": "PACKAGE-CREATE-1",
"images": [
"img1.jpg"
],
"lastDetectedAtLocation": null,
"lastUpdatedDate": 1765420060123,
"location": null,
"name": "Package Create 1",
"state": "incoming",
"trackerSerial": "TRACKER-PKG-CREATE-1",
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-PKG-CREATE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
package.deleted
Sent when packages are deleted. The payload contains the deleted packages.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
id | string |
images | string[] |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
name | string · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "package.deleted",
"data": {
"comments": "Package 1 Comments",
"containerId": null,
"creationDate": 1765420060123,
"customProperties": {
"packageTs": "Package 12345"
},
"description": "Package 1 Description",
"id": "PACKAGE-1",
"images": [
"img1.jpg"
],
"lastDetectedAtLocation": null,
"lastUpdatedDate": 1765420060123,
"location": null,
"name": "Package 1",
"state": "incoming",
"trackerSerial": null,
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": null
}
}
package.moved
Sent when a package is detected at or moved to a new location. The payload contains the full package, including its current and last-detected locations.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
containerId | string · nullable |
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
id | string |
images | string[] |
lastDetectedAtLocation | object · nullable |
lastUpdatedDate | integer |
location | object · nullable |
name | string · nullable |
state | string |
trackerSerial | string · nullable |
trackers | object[] · nullable |
uuid | string |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "package.moved",
"data": {
"comments": "Package Move 1 Comments",
"containerId": "CONTAINER-A1",
"creationDate": 1765420060123,
"customProperties": {
"packageTs": "12345"
},
"description": "Package Move 1 Description",
"id": "PACKAGE-MOVE-1",
"images": [
"img1.jpg"
],
"lastDetectedAtLocation": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": "stockroom"
},
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Zone",
"customProperties": {
"locationTs": null
},
"customerId": "ACME",
"description": "Store 1",
"id": "1-Z",
"name": "Zone 1",
"parentLocationId": "BLDG-A",
"roleId": "stockroom"
},
"name": "Package Move 1",
"state": "onhand",
"trackerSerial": "TRACKER-PKG-MOVE-1",
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-PKG-MOVE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
Work Order
work_order.created
Sent when a new work order is created. The payload contains the full work order and its properties.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
completionDate | integer · nullable |
creationDate | integer |
currentOperation | object · nullable |
customProperties | object (free-form) |
customer | string · nullable |
description | string · nullable |
dueDate | integer · nullable |
inputs | object[] |
isActive | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastDetectionDate | integer · nullable |
lastUpdatedDate | integer |
location | object · nullable |
number | string |
outputs | object[] |
poNumber | string · nullable |
priority | integer · nullable |
startDate | integer · nullable |
state | string · nullable |
status | string · nullable |
statusFlags | string[] |
trackerSerial | string · nullable |
trackerSerialAttachDate | integer |
trackers | object[] · nullable |
uuid | string |
data.currentOperation
| Field | Type |
|---|
delayedStartSeverity | string |
severity | string |
startStatus | string |
status | string · nullable |
| Field | Type |
|---|
category | string |
id | string |
isActive | boolean · nullable |
name | string · nullable |
quantity | integer · nullable |
trackerSerial | string · nullable |
type | object · nullable |
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.outputs
| Field | Type |
|---|
category | string |
id | string |
isActive | boolean · nullable |
name | string · nullable |
quantity | integer · nullable |
trackerSerial | string · nullable |
type | object · nullable |
data.outputs.type
| Field | Type |
|---|
creationDate | integer |
customProperties | object (free-form) |
description | string · nullable |
id | string |
imagePath | string · nullable |
images | string[] |
lastUpdatedDate | integer |
name | string · nullable |
number | string · nullable |
quantity | integer · nullable |
unit | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "work_order.created",
"data": {
"comments": "Rush order",
"completionDate": 1765520060000,
"creationDate": 1765420060123,
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "WARNING",
"startStatus": "NOT_STARTED",
"status": "NOT_STARTED"
},
"customProperties": {},
"customer": "Acme Corp",
"description": "Widget assembly job",
"dueDate": 1765420060000,
"inputs": [
{
"category": "Raw Material",
"id": "PART-IN-1",
"isActive": null,
"name": null,
"quantity": 10,
"trackerSerial": null,
"type": null
}
],
"isActive": true,
"lastDetectedAtLocation": null,
"lastDetectionDate": null,
"lastUpdatedDate": 1765420060123,
"location": null,
"number": "WO-CREATE-1",
"outputs": [
{
"category": "Finished Good",
"id": "PART-OUT-1",
"isActive": null,
"name": null,
"quantity": 5,
"trackerSerial": null,
"type": null
}
],
"poNumber": "PO-12345",
"priority": 2,
"startDate": 1765410060000,
"state": null,
"status": "IN_PROGRESS",
"statusFlags": [
"DELAYED"
],
"trackerSerial": "TRACKER-WO-CREATE-1",
"trackerSerialAttachDate": 1765420060123,
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "TRACKER-WO-CREATE-1",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}
work_order.moved
Sent when a work order is detected at or moved to a new location. The payload contains the full work order, including its current and last-detected locations.
Payload (data)
| Field | Type |
|---|
comments | string · nullable |
completionDate | integer · nullable |
creationDate | integer |
currentOperation | object · nullable |
customProperties | object (free-form) |
customer | string · nullable |
description | string · nullable |
dueDate | integer · nullable |
inputs | object[] |
isActive | boolean · nullable |
lastDetectedAtLocation | object · nullable |
lastDetectionDate | integer · nullable |
lastUpdatedDate | integer |
location | object · nullable |
number | string |
outputs | object[] |
poNumber | string · nullable |
priority | integer · nullable |
startDate | integer · nullable |
state | string · nullable |
status | string · nullable |
statusFlags | string[] |
trackerSerial | string · nullable |
trackerSerialAttachDate | integer |
trackers | object[] · nullable |
uuid | string |
data.currentOperation
| Field | Type |
|---|
delayedStartSeverity | string |
severity | string |
startStatus | string |
status | string · nullable |
data.lastDetectedAtLocation
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.location
| Field | Type |
|---|
categoryId | string |
customProperties | object (free-form) · nullable |
customerId | string · nullable |
description | string · nullable |
id | string |
name | string · nullable |
parentLocationId | string · nullable |
roleId | string · nullable |
data.trackers
| Field | Type |
|---|
attachDate | integer · nullable |
customProperties | object (free-form) · nullable |
encodingFormat | string · nullable |
serial | string |
Example event
{
"id": "c1314cc5-60f7-ddba-7be3-900030a8ee05",
"eventTimestamp": 1765572297000,
"topic": "work_order.moved",
"data": {
"comments": null,
"completionDate": null,
"creationDate": 1765420060123,
"currentOperation": null,
"customProperties": {},
"customer": null,
"description": null,
"dueDate": null,
"inputs": [],
"isActive": true,
"lastDetectedAtLocation": {
"categoryId": "Dock Door",
"customProperties": {
"locationTs": "Reader location"
},
"customerId": null,
"description": "At detector",
"id": "Dock Door 1",
"name": "Dock Door 1",
"parentLocationId": null,
"roleId": null
},
"lastDetectionDate": 1765420060123,
"lastUpdatedDate": 1765420060123,
"location": {
"categoryId": "Dock Door",
"customProperties": {
"locationTs": "Reader location"
},
"customerId": null,
"description": "At detector",
"id": "Dock Door 1",
"name": "Dock Door 1",
"parentLocationId": null,
"roleId": null
},
"number": "WO-TRACKER-001",
"outputs": [],
"poNumber": null,
"priority": null,
"startDate": null,
"state": null,
"status": null,
"statusFlags": [],
"trackerSerial": "WO-TRACKER-001",
"trackerSerialAttachDate": 1765420060123,
"uuid": "11111111-1111-4111-8111-111111111111",
"trackers": [
{
"serial": "WO-TRACKER-001",
"attachDate": 1765420060123,
"encodingFormat": "SGTIN-96",
"customProperties": {
"tagManufacturer": "Example Tag Manufacturer"
}
}
]
}
}