Skip to content

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
FieldTypeRequiredDescription
titlestringYESNotification title.
contentstringYESBody text.
domainstringYESContent domain, e.g. patron-ui.
categorystringYESContent category.
sessionIdstringYESInjected.
institutionIdstringYESInjected.
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
FieldTypeRequiredDescription
includeViewedbooleanYEStrue in the app.
includeDismissedbooleanYESfalse in the app.
includePinnedbooleanYEStrue 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 ​

ValueNameShown in bell?
1orderYES
2accountno
3adminNoticeno
4mealno
5rewardno
6photoUploadYES
7automaticDepositno
8lowBalanceno
9guestDepositno
10walkOutno

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
FieldTypeRequired
userNotificationLogIdstringYES

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: markUserNotificationLogAsViewed
json
{
    "method": "markUserNotificationLogAsViewed",
    "params": { "userNotificationLogId": "{NOTIFICATION_ID}", "sessionId": "{SESSION_ID}" }
}

Mark as Dismissed ​

plaintext
POST /json/userNotification
method: markUserNotificationLogAsDismissed

Same 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: markAllUserNotificationLogAsViewed

No parameters beyond the injected session.

Unread Count ​

plaintext
POST /json/userNotification
method: getNotificationLogCount
FieldTypeRequired
includeViewedbooleanYES — false
includeDismissedbooleanYES — 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
FieldTypeRequiredDescription
userNotificationLogIdstringYESNotification id.
valuebooleanYEStrue to pin, false to unpin.
json
{
    "method": "updatePinnedOnUserNotificationLog",
    "params": {
        "userNotificationLogId": "{NOTIFICATION_ID}",
        "value": true,
        "sessionId": "{SESSION_ID}"
    }
}