Custom application messages broadcast between clients. Clients publish
with `useBroadcastWebsocketMessage` (setting a `target`) and subscribe
with `useOnWebsocketMessage`. A trusted server broadcasts the same
message shape with `whopApi.websockets.sendMessage`.
Receive custom app messages for subscribed targets.
Messages
AppMessage
A custom message broadcast between app clients with a target.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.