Document toolboxDocument toolbox

Webhook Request Object

Owned by Mickey Bushman
Jul 29, 2022
1 min read

Webhook Request Object Formats

JSON Format 
{
    "id": "f0facfbb-e945-4b90-977d-1671bc0c60ab",
	"type": "Activity|PhysicalInventoryRequest|LoadInventory|InventoryTransfer|InventoryUsage|StockLevelRecommendation|TimeEntry|UserAudit|WorkOrder",
	"specversion": "1.0",
	"source": "5ad09380-8258-4d84-a440-e2d35043ae92",
	"subject": null, // Not used
	"time": "2022-07-27T23:10:12.000Z",
	"datacontenttype": "application/json",
	"action": "",
	"data": {} // Will vary depending on precise use case
}

Webhook Request Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
idstring

ID representing this unique payload. Subsequent requests with duplicate IDs should be disregarded.

typestring

The object type represented by the data field.

Valid values are:

  • Activity
  • PhysicalInventoryRequest
  • LoadInventory
  • InventoryTransfer
  • InventoryUsage
  • StockLevelRecommendation
  • TimeEntry
  • UserAudit
  • WorkOrder
specversionstringThe CloudEvents spec version that this payload complies with.
sourcestringThe ID of the webhook that generated this message.
subjectstringNot used.
timestringTime that this webhook execution was generated.
datacontenttypestring

The format of the data object.

Valid values are:

  • application/json
actionstringAdditional information and context for this webhook call.
dataobject

The data payload, matching the format of the object type specified in type property.

typedata

Activity

Activity Export Notification Object

PhysicalInventoryRequest

Physical Inventory Request Export Notification Object

LoadInventory

Inventory Load Export Notification Object

InventoryTransfer

Inventory Transfer Export Notification Object

InventoryUsage

Inventory Usage Export Notification Object

StockLevelRecommendation

Stock Level Recommendation Export Notification Object

TimeEntry

Time Entry Export Notification Object

UserAudit

User Audit Export Notification Object

WorkOrder

Work Order Export Notification Object