WebSocket API
Kchannels provides WebSocket endpoints to provide real-time messaging about the state of the channel as well in incoming and outgoing transactions. Every client should always keep both of these WebSockets open to stay up-to-date on what is happening in the channel.
Make sure to replace <ZONE>
, <NETWORK>
, <CHANNEL_UUID>
, and <CHANNEL_DEFINITION_VERSION>
with the appropriate values.
Channel information
URL: wss://<ZONE>.<NETWORK>.kchannels.io/client/ws/channel/<CHANNEL_UUID>/<CHANNEL_DEFINITION_VERSION>/
REQUEST:
Query params:
access_token
-- JWT token used for authentication
RESPONSE:
Body:
The backend returns
ChannelInfo
WebSocket messages.
Transaction information
URL: wss://<ZONE>.<NETWORK>.kchannels.io/client/ws/transaction/<CHANNEL_UUID>/<CHANNEL_DEFINITION_VERSION>/
REQUEST:
Query params:
access_token
-- JWT token used for authentication
RESPONSE:
Body:
The backend returns
TransactionInfo
WebSocket messages.
Last updated