Namespace Reference
Notifications and realtime
Curated JQL namespaces and examples for notifications and realtime.
Notification namespaces cover templates, in-app notification state, profile settings, realtime notification controllers, MQTT connection bootstrap, and JQL event streams.
Key namespaces and models
notifications.Templatenotifications.Notificationnotifications.Settingsnotifications.ProfileSettingrealtime_notifications.Notificationchat conversation data through chat controllers
Common controller intents
realtime_notifications.Notification.getNotificationsrealtime_notifications.Notification.getUnreadCountrealtime_notifications.Notification.markAsReadrealtime_notifications.Notification.markAllAsReadrealtime_notifications.Notification.getRealtimeConfigrealtime_notifications.Notification.getMqttConnectionchat.Chat.getConversationschat.Chat.sendTyping
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "notifications.Notification",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "notifications.Template",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Task assigned",
14 "alias": "task-assigned",
15 "subject": "You have a new task"
16}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.
Related guides and modules
Realtime channels
Model mutations dispatch subscriptions such as jql:tickets.Ticket:update and jql:tickets.Ticket:update:123. WebSocket clients connect to /jql-streams; cloud realtime notification delivery uses MQTT connection details from realtime_notifications.Notification.getMqttConnection.