DocsCommunicationHow messages travel

How messages travel

Data reaches WBSKT and leaves it in a handful of ways. Boards hold one connection open, outside services call in over HTTPS, and workflows reach out to the services you connect.

The whole picture

Your boardESP32, Pi, PC, app
Outside servicesGitHub, IFTTT, a script
You, in the consolebrowser
WBSKTgateway, workflows, API
Commandsback to your board
NotificationsTelegram, Discord, email
Other APIsHome Assistant, any URL
WebSocketWebhookSignalRcommandactionHTTP

Ways in and out

Readingsboard → WBSKT

Messages your board sends over its WebSocket, with a type and a payload. They start workflows and are kept for charts. Late ones (sent while offline) are marked.

CommandsWBSKT → board

Sent from the console or a workflow. They wait up to 24 hours for an offline board and the board confirms each with sys.ack.

Stateboard → WBSKT

What the board is doing now, sent as state.report. The console shows the latest value and charts numbers.

Capabilitiesboard → WBSKT

The commands a board takes and their parameters, sent first on every connection, so the console can draw a form for them.

Presence and latencyWBSKT ↔ board

WBSKT pings each board and times the reply. Online, offline and round-trip time show in the console and can start a workflow.

Firmware updatesWBSKT → board

A link and a checksum for new firmware, sent as sys.ota.update. The board reports progress until the new version connects.

Webhooks inservice → WBSKT

A Webhook received trigger gives a workflow its own URL. Anything that can POST JSON can start a run.

Callbacksservice → WBSKT

A Wait for a call step gives one run a one-off URL and parks until it is called, for approvals or slow jobs.

NotificationsWBSKT → you

Email, Telegram, Discord, ntfy and console notifications, sent by workflow actions through your integrations.

Calls outWBSKT → service

The Call a URL node calls any HTTP API, with an HTTP auth integration when it needs a token.

Live consoleWBSKT → browser

The console stays live over SignalR: presence, readings, run progress and the workspace message rate, without refreshing.

HTTP APIyou → WBSKT

Everything the console does is an HTTPS call under /api/v1, so scripts can do it too.

Which one should I use?

You want toUse
Get a value from a board into WBSKTA reading, from an SDK's send
Show what a board is doing right nowState, from reportState
Make a board do somethingA command, from the console or a Send to client node
Start a workflow from another serviceA Webhook received trigger
Wait for a person or slow job to answerA Wait for a call or Wait for signal step
Tell yourself something happenedA notification action: Telegram, email, Discord or ntfy

The exact format of everything a board sends and receives is in the client protocol.