PubSub Client | SignalWire

The PubSub Client enables real-time publish/subscribe messaging. Access it via the pubSub property on a SignalWire Client.

1 import { SignalWire } from "@signalwire/realtime-api";
2 
3 const client = await SignalWire({ project: "<project-id>", token: "<api-token>" });
4 const pubSubClient = client.pubSub;

Use subscribe() to join channels, publish() to send messages, and listen to receive events. See Events for all available events.

Examples

Listening for messages

1 await pubSubClient.listen({
2   channels: ["notifications"],
3   onMessageReceived: (message) => {
4     console.log("Received:", message.content);
5   }
6 });

Publishing messages

1 await pubSubClient.publish({
2   channel: "notifications",
3   content: { type: "alert", text: "New update available" },
4 });