Payload to Webhook Endpoints
The following subsections show a sample payload that would be delivered to a webhook endpoint when a certain event occurs.
Entitlement Event Sample Payload
{
"eventHeader": {
"event": "ENT",
"eventType": "UPDATE",
"userId": "1000admin",
"tenant": "1000",
"timeStamp": "1683289809743"
},
"eventBody": {
"entitlementId": "3395",
"entitlementName": "NOTIF-TEST-3",
"version": "1.0",
"soldToAccount": "SAMPLE_ORG",
"accounts": [
"SAMPLE_ORG"
],
"lineItems": []
}
}
Line Item Event Sample Payload
{
"eventHeader" : {
"event" : "ENT",
"eventType" : "UPDATE",
"userId" : "1000admin",
"tenant" : "1000",
"timeStamp" : "1682400267304"
},
"eventBody" : {
"entitlementId" : "3394",
"entitlementName" : "NOTIF-TESTS-1",
"version" : "1.0",
"soldToAccount" : "SAMPLE_ORG",
"accounts" : [ "testAccount", "SAMPLE_ORG" ],
"lineItems" : [ {
"activationId" : "ACT-e0e0-7045-B6c2-781",
"description" : "line desc",
"licenseModel" : "Floating Counted",
"orderId" : "addedordId",
"copies" : "10",
"exactAvailableCount" : "9",
"startDate" : "1680048000000",
"expirationDate" : null,
"products" : [ {
"name" : "prodtest1",
"version" : "2.0"
} ]
"lineItemCustomAttributes" : {
"textAttribute" : [ "demo value" ],
"boolAttribute" : [ "false" ]
}
} ]
}
}
Note:In the above sample payload for a line item event, the "lineItemCustomAttributes" element is returned only if includeLineItemCustomAttributes is set to true.
Product Event Sample Payload
{
"eventHeader": {
"event": "PROD",
"eventType": "UPDATE",
"userId": "1000admin",
"tenant": "1000",
"timeStamp": "1665044575475"
},
"eventBody": {
"productId": "1676",
"productName": "demo-product-for-notifications",
"version": "1.0",
"features": [
{
"featureName": "2Dline",
"version": "1",
"count": "1"
}
]
}
}
Device Event Sample Payload
"ownerName": null,"
"addOnInfoList": null,
"statusInfos": []
The statusInfos field provides status information for the event. For successful events, the field is empty. For failed events, it includes a statusCode and a descriptive statusMessage indicating the reason for the failure, for example:
"statusInfos" : [ {
"statusCode" : 1,
"statusMessage" : "Specified activation ID is invalid: fc45-2g37-0g57-4450-b96b-156a-3r3e-905"
} ]
Note:The statusInfos field is always included in the payload. However, it contains status information for failed events only when the device webhook enhancement is enabled for the deployment. This enhancement ensures that device webhook events are consistently triggered whenever entitlements or activation IDs are mapped to devices. If the enhancement is not enabled, the statusInfos field remains present but is not populated.
The statusInfos field provides status information for the event. For successful events, the field is empty. For failed events, it includes a statusCode and a descriptive statusMessage indicating the reason for the failure, for example:
"statusInfos" : [ {
"statusCode" : 1,
"statusMessage" : "Specified activation ID is invalid: fc45-2g37-0g57-4450-b96b-156a-3r3e-905"
} ]
Note:The statusInfos field is always included in the payload. However, it contains status information for failed events only when the device webhook enhancement is enabled for the deployment. This enhancement ensures that device webhook events are consistently triggered whenever entitlements or activation IDs are mapped to devices. If the enhancement is not enabled, the statusInfos field remains present but is not populated.