Field Name | Type | Description |
---|
token | String | Authentication token generated from the appropriate endpoint. |
type | Integer | Connection type. Value from the IdentifyType enum. |
Name | Value |
---|
User (Producer) | 0 |
Developer (Consumer) | 1 |
Field Name | Type | Description |
---|
op | Integer | Opcode for the payload. |
d? | Object | Event data. |
uid?* | String | User ID that the event relates to. |
seq?* | Long | Sequence number of the payload. Used when replaying missed payloads. |
t?* | String | The event type for the payload. |
Key:
? -> Optional field
* -> Only send with payloads of the DISPATCH opcode
{
"op": 5,
"d": {
"ts": "2022-05-04T10:26:11.268507+01:00",
"val": 95
},
"uid": "8e864e3a-979a-4d04-b4e9-b6d020f20ba0",
"seq": 73,
"t": "HEART_RATE"
}
Name | Value | Description | Sent By |
---|
HEARTBEAT | 0 | Fired periodically by the client to keep the connection alive. | Client |
HEARTBEAT_ACK | 1 | Sent by the server to acknowledge that a heartbeat has been received. | Server |
HELLO | 2 | Sent by the server immediately after connecting. Contains the heartbeat interval for the client to use. | Server |
IDENTIFY | 3 | Sent by the client to complete the handshake with the server. Contains authentication details. | Client |
READY | 4 | Sent by the server once the handshake has been completed. The client will be able to receive/send payloads immediately after this is received. | Server |
DISPATCH | 5 | An event dispatched by the server. Contains details about the event, as well as the data payload for the event. | Server |
SUBMIT | 6 | Sent by the client to notify the server of new data which will then be routed to the correct consumer appropriately. | Client (producer only) |
REPLAY | 7 | Request a replay of payloads after the given lower bound, and optionally before a given upper bound. | Client (consumer only) |
Code | Reason |
---|
1001 | Server is shutting down |
1007 | Invalid or unrecognised JSON data was provided |
4000 | IDENTIFY payload expected but was not received |
4001 | Improper token was passed for IDENTIFY |
4002 | Duplicate connection opened |
4003 | Multiple IDENTIFY payloads received |
4004 | Unrecognised opcode was received |