Messaging

Overview

Real-time messaging: conversation CRUD, messages, members, Console settings, and a SignalR hub at /messaging/hub.

API

{pe} = /projects/{projectId}/environments/{environmentId}.

MethodPathNotes
GET/messaging/healthHealth
GET/PUT/messaging{pe}/settingsConsole JWT
POST/GET/messaging{pe}/conversationsAPI key or JWT
GET/messaging{pe}/conversations/{conversationId}/messagesDual-auth
POST/messaging{pe}/conversations/{conversationId}/membersDual-auth
Hub/messaging/hubSignalR; SDK CORS

Clients

PackageRuntime
@vijihub/messagingdual / live (scoped messaging:live)
VijiHub.Messaging.NET

Implementation

  1. Enable Messaging and configure settings in Console.
  2. Create conversations and post messages via REST with JWT or API key.
  3. Connect browsers to /messaging/hub using a scoped messaging:live key (or session proxy).
  4. Add members through the members endpoint as your app model requires.

Constraints

  • Settings endpoints are Console JWT only.
  • Prefer scoped keys for browser live connections — not full admin keys.
  • CORS must allow your app origin for the hub.
  • See Authentication scoped key table.