Console

The Console is an interactive playground inside a project. Use it to verify API keys, publish test messages, watch connection logs, and simulate additional subscribers—without writing an app.

Open a project in the dashboard, then select the Console tab.

You need at least one API key in the project before the console can connect.

Layout

Three panels:

PanelPurpose
ControlsMain connection: pick an API key, choose a channel, publish
LogsLive connection and subscription activity for the project
ClientsSimulated clients that can connect, subscribe, and publish

The header shows connection status (for example Connected, Connecting, Failed) and Ping latency.

Publish a test message

  1. In Controls, select an API Key.
  2. Enter a Channel name (default my-channel) and click Use (it shows Using ✓ when active).
  3. Optionally set Event name and Alias for the message.
  4. Write the Message body (string, JSON, or other text).
  5. Click the send control (↑). Send stays disabled until the channel is active, the message is non-empty, and the connection is ready.

This uses the selected project API key for the console’s main Socket connection.

Watch logs

The Logs panel streams events such as opened, connected, created, closed, disconnected, and error.

  • Pause / Resume the stream
  • Clear clears the on-screen list only (not server history)
  • Expand an entry for details such as Connection ID, API Key, Client ID, Channel, and related metadata
  • Copy the full log entry as JSON when needed

Simulate clients

Use Clients to open extra Socket sessions (for example one publisher and several subscribers).

  1. Click Add Client.
  2. Choose an API Key, Subscribe Channel name, Event name, and optional Client Alias.
  3. Click Add New Client.
  4. On the client card, click Connect client.
  5. Use Subscribe / Unsubscribe (available after connect). Incoming messages appear in the client panel.
  6. Publish from that client using the To: line (channel and event) and the message field.

You can Edit client (separate subscribe vs publish channel/event, API key, alias) or Delete client.

Simulated clients are session-only: leaving the Console clears them.

Tips

  • Use separate API keys with scoped permissions when testing access control.
  • Prefer the console for development and debugging—not for production traffic.
  • For production apps, use @qpub/sdk or the REST / Socket APIs.
Edit this page on GitHub