Namespace Reference — Modules
Omnichannel
Curated JQL namespaces and examples for omnichannel.
Omnichannel namespaces cover mailboxes, connected devices, customer threads, webchat conversations, messages, assignment state, message queues, team agents, and settings.
Key namespaces and models
omnichannel.Mailboxomnichannel.Deviceomnichannel.Threadomnichannel.WebChatConversationomnichannel.Messageomnichannel.ThreadAssignmentStateomnichannel.ThreadAssignmentLogomnichannel.MessageQueueomnichannel.OmnichannelTeamAgentomnichannel.OmnichannelSettings
Common controller intents
omnichannel.Omnichannel.getWebchatConfigomnichannel.Omnichannel.requestWebchatTokenomnichannel.Omnichannel.sendWebchatMessageomnichannel.Omnichannel.getDashboardomnichannel.Omnichannel.getThreadsomnichannel.Omnichannel.sendReplyomnichannel.Omnichannel.assignThreadomnichannel.Omnichannel.closeThread
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
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "omnichannel.Thread",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "omnichannel.Mailbox",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Support mailbox",
14 "email": "support@example.com"
15}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.