...
Messages in the Streaming API are "flattened" for easier processing. Consumers should parse the "packetType" property first and then handle the message accordingly.
| Property Name | Value Type | Description | Always Present |
|---|---|---|---|
| eventUuid | String | A unique value generated on initial VIOLATION or ENTER event - corresponding CLEAR or EXIT events will have same value | Yes |
| projectId | Number | The project identifier this location was generated for | Yes |
| policyId | Number | The unique identifier for the policy | Yes |
| blufiId | Number | The blufi device id of the Blufi that supplied the data. | Yes |
| uniqueDeviceID | String | The beacon deviceId if there is a beacon involved in the policy | No |
| oldState | String | The previous event state | Yes |
| newState | String | The new/current event state | Yes |
| value | String | The value observed for violations - implementation of this value depends on policy type | Yes |
| policy | Object | A JSON representation of the target Policy | Yes |
| timestamp | Number | Timestamp value with millisecond accuracy for the first packet that moved the device into violation | Yes |
| timestampCleared | Number | Timestamp with millisecond accuracy for when the first packet that moved the event state to CLEARED or EXIT state. | No |
Example Packets
Note: Properties not supported by the example packet type are omitted. Fields defined above as "Always Present" should never be null, other fields may be null.
...