Starting a connection

Starting up a connection

When creating a connection, and authentication can be done:

Response:

{
    "is_authenticated": True,
    "allowed_rooms": [{
        "target": "message",
        "customer": "1"
    }]
}

When creating a connection, and authentication can not be done:

Response:

{
    "is_authenticated": False
}

Subscribing to a room

Request:

{
    "type": "subscribe",
    "room": {
        "target": "message",
        "customer": "1"
    },
    "requestId": "1"
}

Response when you have permission:

{ "code": "success" }

Response when you don’t have permission or the room doesn’t exist:

{
    "code": "error",
    "message": "room-not-found"
}

TODO: document unsubscribe

Room permissions

The initial message send from the server contains an allowed_rooms key. This allowed_rooms key determines which rooms which the client can subscribe to. Upon subscribing, the server checks if the client is allowed into the room, but once connected no futher permission checking is done. An example server response upon creating a connection:

{
    "is_authenticated": True,
    "allowed_rooms": [{
        "room": "user-login",
        "department": "finance"
    }, {
        "room": "user-logout",
        "department": "finance"
    }, {
        "target": "chat-create",
        "customer": "*"
    }, {
        "target": "chat-update",
        "customer": "*"
    }]
}

The key / value pairs have no meaning, other then identifying a room. An exception is the special * character, which means that anything will match in place of that character. For the response above, it means the client can connect to the 4 rooms described in allowed_rooms, but also to:

{
    "type": "subscribe",
    "room": {
        "target": "chat-create",
        "customer": "*"
    },
    "requestId": "1"
}

{
    "type": "subscribe",
    "room": {
        "target": "chat-create",
        "customer": "1"
    },
    "requestId": "2"
}

{
    "type": "subscribe",
    "room": {
        "target": "chat-create",
        "customer": "2"
    },
    "requestId": "3"
}

Sending data to a room

To send data to a room, send a POST request to the server:

{
    [
        {
            "target": "chat-create",
            "customer": "*"
        },
        {
            "target": "chat-create",
            "customer": "1"
        },
        {
            "target": "chat-create",
            "customer": "2"
        }
    ],
    "data": "Example text body"
}

Using the *, we can cut 2 rooms. So this is the exactly the same as:

{
    [
        {
            "target": "chat-create",
            "customer": "*"
        }
    ],
    "data": "Example text body"
}

TODO: Implement this TODO: Add test for trigger http endpoint

Ping pong

The frontend can send a ping message to check if the websocket connection is still working. HT will send a pong message if the connection is still open

Request:

ping

Response:

pong