Skip to content

Communication API

The canonical v1 REST contract exposes three POST operations for publishing messages to a channel, across an extension, or to the viewer represented by the JWT.

All paths below are relative to https://api.muxy.io/v1/e and require the standard Authorization header.

Target Method and path Generated operation reference
Channel POST /broadcast Send a channel broadcast
Extension-wide POST /extension_broadcast Send an extension-wide broadcast
Current viewer POST /whisper_self Send a message to the current viewer

See Broadcast Messaging for delivery guidance. Payload fields, authorization outcomes, and response schemas remain canonical in the generated operation pages and OpenAPI; they are not duplicated here.

Canonical OpenAPI

See the raw rest-v1.yaml specification. Sandbox token creation is defined separately in raw sandbox-v1.yaml.