Kchannels
Search…
Kchannels
Kchannels documentation
Introduction
Welcome
Features
Technical overview
Motivation
FAQ
Architecture
Overview
Authentication and authorization
Components
Channels
Modes
Transactions
Scaling
Dispute resolution
Security
Developers
API
Schemas
API authentication
JSON-RPC API
Supporting API
WebSocket API
EIP-712 signatures
Libraries
Wallets
Fiat onramps
White paper
Deployments
Powered By GitBook
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.
Previous
Supporting API
Next
EIP-712 signatures
Last modified 1yr ago
Copy link
Contents
Channel information
Transaction information