Appearance
Notifications
Service path: /json/userNotification
This is the in-app notification log — the list behind the bell icon. It is separate from push-notification registration, which lives on the user record.
Create a Notification
Writes a notification into the current user's log.
plaintext
POST /json/userNotification
method: createUserNotificationLog| Field | Type | Required | Description |
|---|---|---|---|
title | string | YES | Notification title. |
content | string | YES | Body text. |
domain | string | YES | Content domain, e.g. patron-ui. |
category | string | YES | Content category. |
sessionId | string | YES | Injected. |
institutionId | string | YES | Injected. |
json
{
"method": "createUserNotificationLog",
"params": {
"title": "Order ready",
"content": "Your order is ready for pickup.",
"domain": "patron-ui",
"category": "core-ui",
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_UUID}"
}
}List Notifications
plaintext
POST /json/userNotification
method: retrieveAll| Field | Type | Required | Description |
|---|---|---|---|
includeViewed | boolean | YES | true in the app. |
includeDismissed | boolean | YES | false in the app. |
includePinned | boolean | YES | true in the app. |
json
{
"method": "retrieveAll",
"params": {
"includeViewed": true,
"includeDismissed": false,
"includePinned": true,
"sessionId": "{SESSION_ID}"
}
}Response is { "list": [ ... ] }.
json
{
"response": {
"list": [
{
"id": "{NOTIFICATION_ID}",
"title": "Order ready",
"content": "Your order is ready for pickup.",
"category": 1,
"type": 1,
"createdDate": "2026-11-19T12:00:00",
"viewedDate": null,
"dismissedDate": null,
"pinned": false
}
]
},
"exception": null
}Notification categories
| Value | Name | Shown in bell? |
|---|---|---|
1 | order | YES |
2 | account | no |
3 | adminNotice | no |
4 | meal | no |
5 | reward | no |
6 | photoUpload | YES |
7 | automaticDeposit | no |
8 | lowBalance | no |
9 | guestDeposit | no |
10 | walkOut | no |
NOTE
GET Mobile's bell only renders categories order and photoUpload. Other categories are still returned by retrieveAll but filtered out client-side.
Get One Notification
plaintext
POST /json/userNotification
method: retrive| Field | Type | Required |
|---|---|---|
userNotificationLogId | string | YES |
WARNING
The method name is spelled retrive (missing an e) in the app. Sending retrieve will fail.
Mark as Viewed
plaintext
POST /json/userNotification
method: markUserNotificationLogAsViewedjson
{
"method": "markUserNotificationLogAsViewed",
"params": { "userNotificationLogId": "{NOTIFICATION_ID}", "sessionId": "{SESSION_ID}" }
}Mark as Dismissed
plaintext
POST /json/userNotification
method: markUserNotificationLogAsDismissedSame parameter shape.
TIP
The app marks a notification as viewed automatically when it is dismissed or pinned, but only if it has no viewedDate yet.
Mark All as Viewed
plaintext
POST /json/userNotification
method: markAllUserNotificationLogAsViewedNo parameters beyond the injected session.
Unread Count
plaintext
POST /json/userNotification
method: getNotificationLogCount| Field | Type | Required |
|---|---|---|
includeViewed | boolean | YES — false |
includeDismissed | boolean | YES — false |
Response is a number.
NOTE
The app displays the count as "1"–"9", then "9+" for anything larger.
Pin / Unpin
plaintext
POST /json/userNotification
method: updatePinnedOnUserNotificationLog| Field | Type | Required | Description |
|---|---|---|---|
userNotificationLogId | string | YES | Notification id. |
value | boolean | YES | true to pin, false to unpin. |
json
{
"method": "updatePinnedOnUserNotificationLog",
"params": {
"userNotificationLogId": "{NOTIFICATION_ID}",
"value": true,
"sessionId": "{SESSION_ID}"
}
}