PubSub | SignalWire

Access the PubSub API Consumer. You can instantiate a PubSub.Client to subscribe to PubSub events.

Refer to PubSub Events for the full list of events that a PubSub.Client can subscribe to.

Example

The following example logs the messages sent to the “welcome” channel.

1 import { SignalWire} from "@signalwire/realtime-api";
2 
3 const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4 
5 const pubSubClient = client.pubSub;
6 
7 await pubSubClient.listen({
8   channels: ["welcome"],
9   onMessageReceived: (message) => {
10     console.log("Received message:", message);
11   }
12 });

Classes

Client

The main PubSub client for publishing messages and subscribing to channels.

PubSubMessage

Represents a message received on a PubSub channel with content and metadata.