Jetstream API
Event Types

HeartbeatEvent

4min

About

HeartbeatEvent is used to indicate that a device is still working properly and has internet connectivity. If a device is offline, it will not have HeartbeatEvents. Each device will send a HeartbeatEvent at the interval specified in its HeartbeatInterval parameter, regardless of any other events.

Fields

Property

Details

Type

string

The type of Jetstream event.

EventId

string Unique

The ID assigned to the event.

EventTime

string

The time that the event occurred.

The value is expressed in UTC.

This value is expressed in the following format: yyyy-MM-ddTHH:mm:ssZ

Version

int

The Jetstream version of the event.

Device

string

The name of the device.

ReceivedTime

string

The time that the event was received from the device.

The value is expressed in UTC.

This value is expressed in the following format: yyyy-MM-ddTHH:mm:ssZ

Example

Published HeartbeatEvent

{ "Device": "MyDeviceName", "ReceivedTime": "2018-05-19T06:14:59Z", "Type": "HeartbeatEvent", "EventId": "9eebaf4b-52a6-487b-bf2c-b8f8e88bf906", "EventTime": "2018-05-19T06:14:30Z", "Version": 2 }

Version Changes

Addition of the Version property.