This is a brief guide for using our Websocket APIs to connect your backend system with our servers.
Introduction
nandbox WebSocket API is a protocol for communication that offers full-duplex channels over a solitary, persistent connection. WebSockets, in contrast to conventional request-response patterns, enable servers and clients to interact without incurring the cost of continuously opening and shutting connections. Through their servers, nandbox WebSocket effectively handles this real-time, bi-directional communication.
Everything works the same way: your API opens one WebSocket session, authenticates once, then exchanges JSON objects. Each object carries a
method field that says what it is — a request you send, or an event the server sends you.New here? Start in this order
- QUICK START — create an API in your nandbox account and get its token.
- AUTHENTICATION — open the WebSocket session and authenticate.
- MESSAGES — send your first message and handle incoming ones.
- ERROR HANDLING — what the error codes mean.
Looking for something specific?
API REFERENCE — ALL METHODS & CALLBACKS lists every method you can send and every event you can receive, with the callback name for each SDK, on a single page. Start there if you already know what you want to do.
The sections below are grouped by feature area. Pages named after a
method document a request you send; pages named after an event document something the server sends you.
QUICK STARTAUTHENTICATIONERROR HANDLING
MEDIA
PROFILECHATS
MESSAGES
CHATBOT EVENTS
USERSMENUS
SIGNUP MANAGEMENT
COMMERCE — PRODUCT, BOOKING, EVENT
CUSTOM COMPONENT-FORMS AND WORKFLOWSource CodeAPI REFERENCE — ALL METHODS & CALLBACKSEXTENSION DOCUMENT STORE