Skip to content
Last update: April 4, 2024

pushMessages query

This query is used to retrieve push messages, including the unread count and the list of messages.

Arguments

Argument Description
unreadOnly Boolean Flag indicating whether to retrieve only unread messages.
cultureName String A language to retrieve data in.

Possible returns

Possible return Description
PushMessagesResponseType The structured data for push messages response.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  pushMessages (unreadOnly: true, cultureName: "en-Us") {
    unreadCount
    items {
      id
      shortMessage
      createdDate
      isRead
    }
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "data": {
    "pushMessages": {
      "unreadCount": 2,
      "items": [
        {
          "id": "1",
          "shortMessage": "New notification",
          "createdDate": "2024-04-02T08:15:00Z",
          "isRead": false
        },
        {
          "id": "2",
          "shortMessage": "Important update",
          "createdDate": "2024-04-01T16:30:00Z",
          "isRead": false
        }
      ]
    }
  }
}