Namespace Reference — Modules

Chat

Curated JQL namespaces and examples for chat.

Chat uses controller-driven NoSQL-style conversation and message flows for internal messaging, typing events, read state, and presence broadcasts.

Key namespaces and data surfaces

  • chat conversations
  • chat messages
  • chat read state
  • chat typing events

Common controller intents

  • chat.Chat.getConversations
  • chat.Chat.getOrCreateConversation
  • chat.Chat.sendMessage
  • chat.Chat.getMessages
  • chat.Chat.markConversationRead
  • chat.Chat.sendTyping
  • chat.Chat.broadcastPresence

Common intents

Chat is controller-driven. Use schema: "controller" with the chat.Chat namespace. Read-style intents include getConversations, getOrCreateConversation, and getMessages; write-style intents include sendMessage, markConversationRead, sendTyping, and broadcastPresence.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "controller", 4 "namespace": "chat.Chat", 5 "intent": "getConversations", 6 "authenticationClass": "jwt", 7 "limit": 20 8 }, 9 "search": "", 10 "cursor": null 11}

Create/send example

json
1{ 2 "__meta__": { 3 "schema": "controller", 4 "namespace": "chat.Chat", 5 "intent": "sendMessage", 6 "authenticationClass": "jwt" 7 }, 8 "conversationId": "tenant-conversation-id", 9 "body": "Can you review this ticket?", 10 "attachments": [] 11}

Participant ids, conversation ids, and message ids must refer to chat records visible to the authenticated user.