Notification

The Notification API helps you acquire notifications to your user and mark as read

API SUBPATH: eva-notification

Return all notifications.

GET/org/{orgUUID}/notifications/user

Path parameters

orgUUID*string

A valid uuid of an organization

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

createdAtstring (date-time)

Date of creation

readboolean

Reading status

messagesarray of MessageDTO (object)

Message in your specific language

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/notifications/user', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "createdAt": "2024-12-30T17:00:46.621Z",
    "read": false,
    "messages": [
      {
        "language": "text",
        "title": "text",
        "message": "text",
        "url": "text",
        "action": "text"
      }
    ]
  }
]

Mark a user's notifications as read

PUT/org/{orgUUID}/notifications/user

Path parameters

orgUUID*string

A valid uuid of an organization

Header parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/notifications/user', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}