Cloud APIsLocal APIs
Local API Reference
nureva.com

Check the connection

get
https://{nurevaDeviceIP}/api/v1/heartbeat

Allows clients to start a heartbeat stream. This is an SSE endpoint which allows users to check the connection to the device. Every 5 seconds, a heartbeat response of . will be returned as the data from the endpoint, if there is still a connection. We recommend subscribing to this endpoint to check that the device is still connected to your integration rather than polling another endpoint.

Example response body

event: heartbeat data: . retry: 5000

If you are subscribed to the other SSE endpoints, such as the device data stream endpoint, then subscribing to this one as well is redundant. If any SSE endpoint is returning data this indicates that there is still connection. This endpoint would only serve as backup.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

string
required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 27 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
text/event-stream
application/json

Updated 27 days ago