SSE Event Schema

After subscriptions are added, objecfts of sensor_measurement and client_push will be sent to the already setup connection (using the GET call). The received message format can be expected based on the subscriptions added.

Workflow

Connect to the SSE endpoint (GET)

Use the clientId obtained from the Connect step to add subscriptions (POST)

sensor_measurement

New data has been received from the sensor. You can call the Sensor Readings endpoint to fetch details.

{
    "type": "sensor_measurement",
    "client_id": "0083vz18243vo5n",
    "sensor_id": "2a41z7t93z046ep",
    "measurement_id": "7idezffwlbkjh2c",
    "rssi": -33,
    "sec_since_last_msg": 60,
    "gwno": 2
}

client_push

A new push notification has been sent to the user device(s).

{
    "type": "client_push",
    "title": "Some title",
    "message": "Some message",
    "client_id": "0083vz18243vo5n",
    "sensor_id": "04tf2tzyc2m868q",
    "gateway_id": "",
    "push_id": "8eix0igluk6la4n",
    "badge": 1,
    "color": "",
    "sound": "default",
    "messages_sent": 12
}

Workflow#

sensor_measurement#

client_push#

Workflow

sensor_measurement

client_push