Notification Event Types and Delivery Formats
Here is the list of supported notification types.
Id Description { "sku":"string", } { { Status can be 1:created 2:updated 3: deleted { Status can be 1:created 2:updated 3: deleted JSON Data Type { String Data Type { Int/double Data Type {Is Notification available Description Purpose Is Property Specific Message Example 1 Add Company No 2 Remove Company No 7 Activate Product Yes A new product was activated Occurs when product get activated. No
"cuId": "CUID1",
"priority": 0,
"timeStamp": "2017-09-15T10:40:15.5235902+00:00",
"messageType": 7,
"message": "string",
"data":{
"hwVer":"string",
"swVer":"string",
"deviceId":"string"
}8 Add User No 9 Update User No 12 Activate Dynamic Endpoint Yes Device (EP) added to a product Occurs when new dynamic endpoint added to product. No {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":12,
"message": "string",
"data":{
"sku":"string",
"mfgId":"string",
"localId":"string",
"name":"string",
"sn":"string"
}
}13 Deactivate Product Yes A product was deactivated Occurs when product get deactivated. No {
"cuId":"CUID1",
"priority": 0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType": 13,
"message": "string",
"data":{
"sku":"string",
"deviceId":"string"
}
}14 Deactivate Dynamic Endpoint Yes Device (EP) was removed from a product Occurs when dynamic endpoint get removed from product. No {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":14,
"message": "string",
"data":{
"sku":"string",
"mfgId":"string",
"localId":"string",
"name":"string",
"sn":"string"
}
}19 Change Command Definition Yes {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":19,
"message": "string",
"data":{
"sku":"string",
"localId":"string",
"mfgId":"string",
"name":"string",
"status":"string"
}
}20 Change Attribute Definition Yes
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":20,
"message": "string",
"data":{
"sku":"string",
"localId":"string",
"mfgId":"string",
"name":"string",
"status":"string"
}
}21 Change Setting Definition Yes
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":21,
"message": "string",
"data":{
"sku":"string",
"localId":"string",
"mfgId":"string",
"name":"string",
"status":"string"
}
}22 Send Command Yes Command was send to the Agent Occurs when portal or cloud sends any command to agent. No {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":22,
"message": "string",
"data":{
"sku":"string",
"localId":"string",
"mfgId":"string",
"name":"string",
"value":"string"
}
}23 Change Custom Field Definition Yes
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":23,
"message": "string",
"data":{
"sku":"string",
"name":"string",
"localId":"string",
"type":"string",
"status":"string",
"mfgId":"string"
}
}24 Update Group Custom Field Value Yes Group Custom Field Updated Occurs when group level custom field value gets updated Yes {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":24,
"message": "string",
"data":{
"sku":"string",
"name":"string",
"value":"string"
}
}25 Update Productline Custom Field Value Yes Productline custom field updated Occurs when productline level custom field value gets updated Yes {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":25,
"message": "string",
"data":{
"sku":"string",
"name":"string",
"value":"string"
}
}26 Update Product Custom Field Value Yes Product custom field updated Occurs when product level custom field value gets updated Yes {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":26,
"message": "string",
"data":{
"sku":"string",
"name":"string",
"value":"string",
"deviceId":"string"
}
}27 Update Dynamic Endpoint Custom Field Value Yes Dynamic end point custom field updated Occurs when dynamic endpoint level custom field value gets updated Yes {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":27,
"message": "string",
"data":{
"sku":"string",
"name":"string",
"value":"string",
"mfgId":"string",
"deviceId":"string",
"localId":"string"
}
}28 Change Attribute Value Yes Data (attribute) sent to the cloud platform Occurs when endpoint (static & dynamic) attribute value get updated. Yes
"cuId": "CUID1",
"priority": 0,
"timeStamp": "2017-09-15T10:40:15.5235902+00:00",
"messageType": 28,
"message": "string",
"data": {
"localId": 1,
"deviceId":"dvc1"
"name": "temperature",
"value": jsonObject,
"deviceTimeStamp": "2017-09-15T10:40:15.5235902+00:00"
}
},
"cuId": "CUID1",
"priority": 0,
"timeStamp": "2017-09-15T10:40:15.5235902+00:00",
"messageType": 28,
"message": "string",
"data": {
"localId": 1,
"deviceId":"dvc1"
"name": "temperature",
"value": "ExampleString",
"deviceTimeStamp": "2017-09-15T10:40:15.5235902+00:00"
}
}
"cuId": "CUID1",
"priority": 0,
"timeStamp": "2017-09-15T10:40:15.5235902+00:00",
"messageType": 28,
"message": "string",
"data": {
"localId": 1,
"deviceId":"dvc1"
"name": "temperature",
"value": 1,
"deviceTimeStamp": "2017-09-15T10:40:15.5235902+00:00"
}
}29 Changes Setting Value Yes Setting was updated Occurs when endpoint (static & dynamic) setting get updated (either from cloud or agent). Yes {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":29,
"message": "string",
"data":{
"sku":"string",
"deviceId":"string",
"localId":"string",
"name":"string",
"mfgId":"string",
"value":"string"
}
}30 User Activity Yes User login and logout Occurs when user login and logout from the portal system No {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":30,
"message": "string",
"data":{
"email":"string",
"activity":"string"
}
}31 Update Dynamic Endpoint Yes Update Dynamic Endpoint {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":31,
"message": "string",
"data":{
TBD
}
}32 Update Group Data Yes Update Group Data {
"cuId":"CUID1",
"priority":0,
"timeStamp":"2017-09-15T10:40:15.5235902+00:00",
"messageType":32,
"message": "string",
"data":{
TBD
}
}