For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notification

Platform announcements shown to the current user.

This operation lists the Navixy platform's own messages to the user, such as service announcements.

These are not tracker events. Anything a device did, or a rule raised, is event history instead.

API actions

API base path: /notification.

Operations that list no errors of their own return only the general error codes.


List notifications

post
/notification/list

List the platform notifications shown to the current user, such as service announcements.

These are platform-level messages, not the tracker event history, which lives under history/.

Callable with an empty body. Also accepts GET.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Responses
200

The notifications

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/notification/list
POST /v2/notification/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "list": [
    {
      "id": 1,
      "message": "text",
      "show_till": "text"
    }
  ]
}

Last updated

Was this helpful?