Azure Events

Azure Events Hub handles the ingestion of messages from IoT devices, allowing you to monitor and take appropriate actions based on device events.

Device Created

{
  "id": "6d02744965cbc5f6b1ab74cd61220fb8101620eef25fee6e05a2068258ade26b",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-11T11:55:53.948Z",
  "eventType": "deviceLifecycleEvents",
  "message": {
    "rawMessage": {
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "etag": "AAAAAAAAAAE=",
      "version": 2,
      "properties": {
        "desired": {
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:55:53.2997327Z"
          },
          "$version": 1
        },
        "reported": {
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:55:53.2997327Z"
          },
          "$version": 1
        }
      }
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-11T11:55:53.948Z",
      "x-opt-enqueued-time": "2023-04-11T11:55:55.202Z",
      "iothub-message-source": "deviceLifecycleEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "101362a7d2f5"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "operationTimestamp": "2023-04-11T11:55:53.2997327Z",
      "opType": "createDeviceIdentity",
      "iothub-message-schema": "deviceLifecycleNotification"
    }
  }
}

Device Deleted

{
  "id": "d3dc6586788567cd1f2360cec5178304698de18349261e1669cceee15df819b4",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-11T11:55:53.948Z",
  "eventType": "deviceLifecycleEvents",
  "message": {
    "rawMessage": {
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "etag": "AAAAAAAAAAE=",
      "version": 2,
      "properties": {
        "desired": {
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:55:53.2997327Z"
          },
          "$version": 1
        },
        "reported": {
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:55:53.2997327Z"
          },
          "$version": 1
        }
      }
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-11T11:55:53.948Z",
      "x-opt-enqueued-time": "2023-04-11T11:55:55.202Z",
      "iothub-message-source": "deviceLifecycleEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "101362a7d2f5"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "operationTimestamp": "2023-04-11T11:55:53.2997327Z",
      "opType": "deleteDeviceIdentity",
      "iothub-message-schema": "deviceLifecycleNotification"
    }
  }
}

Device Connected

{
  "id": "34db0bdf5fd6041a9a67bc4471bffa5d68f6564da029bbdbd12d85abfce66145",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-10T06:48:55.021Z",
  "eventType": "deviceConnectionStateEvents",
  "message": {
    "rawMessage": {
      "sequenceNumber": "000000000000000101D946C0B8EF77F50000001400000000000000000000002D"
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-10T06:48:55.021Z",
      "x-opt-enqueued-time": "2023-04-10T06:48:55.101Z",
      "iothub-message-source": "deviceConnectionStateEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "d70b6048-4746-ee72-bc77-1ee1d30e7185"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "opType": "deviceConnected",
      "iothub-message-schema": "deviceConnectionStateNotification",
      "operationTimestamp": "2023-04-10T06:48:35.1511303Z"
    }
  }
}

Device Disconnected

{
  "id": "6179980e21cd0b208c2125d1406ce7aca031f87cdf9a718b0715ada43f339b25",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-10T07:10:55.95Z",
  "eventType": "deviceConnectionStateEvents",
  "message": {
    "rawMessage": {
      "sequenceNumber": "000000000000000101D946C0B8EF77F50000001400000000000000000000002E"
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-10T07:10:55.95Z",
      "x-opt-enqueued-time": "2023-04-10T07:10:56.048Z",
      "iothub-message-source": "deviceConnectionStateEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "8d104b90-ff4f-915c-5465-41bff45c5d8c"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "opType": "deviceDisconnected",
      "iothub-message-schema": "deviceConnectionStateNotification",
      "operationTimestamp": "2023-04-10T07:10:31.5754232Z"
    }
  }
}

Telemetry

{
  "id": "3952e9a5f40ebf44b94cd243c35edb34c7528a9adae99383fd9d15b8ae4c2fe1",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-10T06:46:58.142Z",
  "eventType": "Telemetry",
  "message": {
    "rawMessage": {
      "latitude": 64.3
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-10T06:46:58.142Z",
      "x-opt-enqueued-time": "2023-04-10T06:46:58.212Z",
      "iothub-message-source": "Telemetry"
    },
    "messageProperties": {
     "location": "us"
    }
  }
}

Device Twin - Reported

{
  "id": "4d0abf14ea68ce2c73e396af2920ecb4746f812745d6450d128887bbc260a4c3",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-11T11:33:36.163Z",
  "eventType": "twinChangeEvents",
  "message": {
    "rawMessage": {
      "version": 19,
      "properties": {
        "reported": {
          "color": "green",
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:33:35.6704778Z",
            "color": {
              "$lastUpdated": "2023-04-11T11:33:35.6704778Z"
            }
          },
          "$version": 15
        }
      }
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-11T11:33:36.163Z",
      "x-opt-enqueued-time": "2023-04-11T11:33:36.215Z",
      "iothub-message-source": "twinChangeEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "ff3168620e6"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "operationTimestamp": "2023-04-11T11:33:35.6704778+00:00",
      "iothub-message-schema": "twinChangeNotification",
      "opType": "updateTwin"
    }
  }
}

Device Twin - Desired (Update)

{
  "id": "6115bb950f9d720afc0823eb6cb3f0a02e13ce494efa05fd3c430bd399c32945",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-11T11:36:23.058Z",
  "eventType": "twinChangeEvents",
  "message": {
    "rawMessage": {
      "version": 20,
      "properties": {
        "desired": {
          "color": "pink",
          "location": "Antarctica",
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:36:23.030985Z",
            "$lastUpdatedVersion": 5,
            "color": {
              "$lastUpdated": "2023-04-11T11:36:23.030985Z",
              "$lastUpdatedVersion": 5
            },
            "location": {
              "$lastUpdated": "2023-04-11T11:36:23.030985Z",
              "$lastUpdatedVersion": 5
            }
          },
          "$version": 5
        }
      }
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-11T11:36:23.058Z",
      "x-opt-enqueued-time": "2023-04-11T11:36:23.146Z",
      "iothub-message-source": "twinChangeEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "ff37a47d23d"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "operationTimestamp": "2023-04-11T11:36:23.0309850Z",
      "iothub-message-schema": "twinChangeNotification",
      "opType": "updateTwin"
    }
  }
}

Device Twin - Desired (Delete)

{
  "id": "8857580c74c63f6249c9221e3a754432c337de3b9f577a14d83f741df02f064a",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-11T11:38:17.497Z",
  "eventType": "twinChangeEvents",
  "message": {
    "rawMessage": {
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "etag": "AAAAAAAAAAY=",
      "version": 22,
      "properties": {
        "desired": {
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:38:17.4637164Z",
            "$lastUpdatedVersion": 6
          },
          "$version": 6
        },
        "reported": {
          "reported": {
            "color": "green"
          },
          "color": "green",
          "$metadata": {
            "$lastUpdated": "2023-04-11T11:36:55.8000436Z",
            "reported": {
              "$lastUpdated": "2023-03-10T12:34:26.0981694Z",
              "color": {
                "$lastUpdated": "2023-03-10T12:34:26.0981694Z"
              }
            },
            "color": {
              "$lastUpdated": "2023-04-11T11:36:55.8000436Z"
            }
          },
          "$version": 16
        }
      }
    },
    "systemProperties": {
      "iothub-connection-device-id": "35b33c15-ebdd-4271-a94c-902221273145",
      "iothub-enqueuedtime": "2023-04-11T11:38:17.497Z",
      "x-opt-enqueued-time": "2023-04-11T11:38:17.604Z",
      "iothub-message-source": "twinChangeEvents",
      "user-id": "testgroup",
      "content-type": "application/json",
      "content-encoding": "utf-8",
      "correlation-id": "ff3be79d0fc"
    },
    "messageProperties": {
      "hubName": "testgroup",
      "deviceId": "35b33c15-ebdd-4271-a94c-902221273145",
      "operationTimestamp": "2023-04-11T11:38:17.4637164Z",
      "opType": "replaceTwin",
      "iothub-message-schema": "twinChangeNotification"
    }
  }
}

Direct Method Message

{
  "id": "63408951-6916-43ff-9e93-185f3e204e80",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-03-24T06:15:32.273Z",
  "eventType": "DirectMethod",
  "message": {
    "rawMessage": {
      "reboot": true
    },
    "systemProperties": {},
    "messageProperties": {},
    "status": 1,
    "response": {
      "locked": "yes"
    },
    "name": "LockDoor",
    "responseTimeoutInSecs": 5
  }
}

Outbound Message

{
  "id": "4c69bcf6-ef75-4398-aea3-87c0450bd785",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-03-20T04:11:53.864Z",
  "eventType": "Outbound",
  "message": {
    "rawMessage": {
      "ping": "location"
    },
    "messageProperties": {
      "interval": 10
    },
    "status": "Success",
    "expiryInSecs": 172800
  }
}

This message will not be delivered to any event hubs.

Feedback Status

Body of the Event Hub message.

{
    "MessageId": "b5435e3e-1040-4381-b68a-e678d0daf3ac",
    "Status": "Success",
    "DeviceId": "dcd8b763-e4e4-45ff-b8ca-02d3e3a54c64"
}

This message will be available only in Event hubs and will not be returned in Messages API. The feedback can be monitored in Outbound Messages API as well.

Error

{
  "id": "8a628fa7f1fd56f86af6593fade1378aa2203aedf1cc6eb19c50de639bb56298",
  "clientId": "35b33c15-ebdd-4271-a94c-902221273145",
  "receivedUtc": "2023-04-10T07:12:46.261Z",
  "eventType": "Error",
  "message": {
    "rawMessage": {
      "Time": "2023-04-10T07:11:16Z",
      "OperationName": "deviceDisconnect",
      "Category": "Connections",
      "ResultDescription": "InternalServerError",
      "Properties": "{\"deviceId\":\"35b33c15-ebdd-4271-a94c-902221273145\",\"protocol\":\"Mqtt\",\"authType\":null,\"maskedIpAddress\":\"34.213.90.XXX\",\"statusCode\":\"500\",\"errorMessage\":\"\"}"
    },
    "systemProperties": {
      "x-opt-sequence-number": 5279,
      "x-opt-offset": 111669149696,
      "x-opt-enqueued-time": "2023-04-10T07:12:46.261Z"
    },
    "messageProperties": {}
  }
}

Certificate Expiry Notification

{
"id": "f8d4385f-a26a-357c-8cea-7ee22fcd9c10",
"clientId": "f80ds002-8ca8-4c4d-89ed-254cf2131f0",
"receivedUtc": "2023-11-17T14:48:22.438Z",
"eventType": "certificateExpiry",
"message": {
    "issuer": "CN=mtls.stage.id.trimble cloud.com-testdevice",
    "subject": "CN=TestDevice92007",
    "registrationDateTime": "2023-11-17T11:48:36.421Z",
    "expirationDateTime": "2026-11-16T11:48:21.000Z"
}
}

This event will not be retrieved using messages API.

Platform event - License Assigned Notification Message

{
        "id": "6c2fe31d-9e73-4e25-90b9-8acb59005ea9",
        "clientId": "10ee7bfc-c1b1-4bd8-951f-5653f099f3f9",
        "receivedUtc": "2025-11-26T14:09:34.521Z",
        "eventType": "Outbound",
        "message": {
            "rawMessage": {
                "event_name": "license_assigned",
                "event_id": "23007bf5-5af1-4719-b69c-d64db861429f",
                "time": "2025-11-26T14:09:32Z",
                "source": "ems",
                "data": "{\"entitlementId\": \"0976985b-3fe3-4f37-a126-963485af0ec7\", \"licenseId\": \"d5307d47-bd26-4d08-afd5-f134f86681fc\", \"holderId\": \"10ee7bfc-c1b1-4bd8-951f-5653f099f3f9\", \"sku\": {\"id\": \"PAD-SB-T4D-123\", \"type\": \"product\"}}"
            },
            "systemProperties": {},
            "messageProperties": {
                "platform-event": "license-notification"
            },
            "status": "Sent",
            "expiryInSecs": 172800
        }
    }

Platform event - License Revoked Notification Message

   {
            "id": "403f7d25-21eb-4504-81c7-c7acd67fd3a6",
            "clientId": "10ee7bfc-c1b1-4bd8-951f-5653f099f3f9",
            "receivedUtc": "2025-11-26T14:10:21.107Z",
            "eventType": "Outbound",
            "message": {
                "rawMessage": {
                    "event_name": "license_revoked",
                    "event_id": "f4525591-6665-49ec-8a5c-2423174774f7",
                    "time": "2025-11-26T14:10:18Z",
                    "source": "ems",
                    "data": "{\"entitlementId\": \"0976985b-3fe3-4f37-a126-963485af0ec7\", \"licenseId\": \"d5307d47-bd26-4d08-afd5-f134f86681fc\", \"holderId\": \"10ee7bfc-c1b1-4bd8-951f-5653f099f3f9\", \"sku\": {\"id\": \"PAD-SB-T4D-123\", \"type\": \"product\"}}"
                },
                "systemProperties": {},
                "messageProperties": {
                    "platform-event": "license-notification"
                },
                "status": "Sent",
                "expiryInSecs": 172800
            }
        }