HypeRate DevDocs
Getting an API key
You need to request your websocket key on our Discord through the ticket system.
I don't have a compatible device! What should I do?
The API sends a random heartbeat between 60 and 80 every second to the
internal-testing device id.
Connecting to the API
URL: wss://app.hyperate.io/socket/websocket?token=<MY-WEBSOCKET-KEY>
Required websocket messages
Join Channel
You need to join the appropiate channel before any data will be sent to your client.
To do this you need to send the following JSON message:
{
"topic": "hr:<ID>",
"event": "phx_join",
"payload": {},
"ref": 0
}This would be the correct message to join the "internal-testing" channel:
{
"topic": "hr:internal-testing",
"event": "phx_join",
"payload": {},
"ref": 0
}Send heartbeat
Phoenix expects that you send a client heartbeat every 30 seconds otherwise the connection will be closed.
{
"topic": "phoenix",
"event": "heartbeat",
"payload": {},
"ref": 0
}