Skip to content

js-bao-wss-client


js-bao-wss-client / ChannelMessageEvent

Interface: ChannelMessageEvent ​

A message a server function published to a channel this client has joined.

Emitted over the channelMessage event channel (client.on("channelMessage", ...)) for every channel this client holds a live membership in — the channel field says which. payload is the function's own value, passed through unread by the platform.

Like DirectMessageEvent it is a LIVE frame with no durable record behind it, and functionKey is its only attribution: a function publishing from a database-change trigger runs as the app and acts for no user.

Properties ​

channel ​

channel: string


functionKey ​

functionKey: string


payload ​

payload: unknown


sentAt ​

sentAt: string

When the platform sent it, ISO 8601.


type ​

type: "channel.message"

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30