Skip to main content

Get User Notifications

GET 
/api/v1/user/notifications

Notifications returned are limited to latest 100.

HTTP RESPONSE​

Standard HTTP code and JSON payload as below.

{
  "notifications": [
    {
      "id": 2,
      "message": "Collection updated by joe@example.org",
      "url": "/collection/1",
      "disposal": "ON_ACK",
      "timestamp": "2022-05-14T07:08:49Z"
    },
    {
      "id": 1,
      "message": "Welcome! New notifications will appear here.",
      "url": null,
      "disposal": "ON_READ",
      "timestamp": "2022-05-15T07:08:15Z"
    }
  ]
}
ParameterDetails
idNotification id, used for disposing
messageNotification text
urlAny associated URL
disposalWhat should be done with the message. See below
categoryGrouping category. See below
statusTask lifecycle state (tasks only). See below
assigned_byTask assigner user id (tasks only), else null
assigned_by_emailTask assigner email (tasks only), else null
timestampISO 8601 datetime indicating when the notification was issued

Notifications have two disposals listed below.

Disposal typeDetails
ON_READDisposed automatically when retrieved
ON_ACKUser must acknowledge the notification to dispose it

CATEGORIES​

Each notification is bucketed into one category for grouping in the UI.

CategoryDetails
mediaAsset/media processing lifecycle (reprocess, transcode)
insightsUsage/analytics (e.g. scheduled agent runs)
billingBilling and subscription events
activitiesAccount & collaboration activity (default)
tasksAn action assigned to the user (see Tasks below)

TASKS​

tasks notifications represent an action assigned to the recipient (for example, an internal user sharing a filtered collection view to review). A task carries a status and an assigned_by:

StatusDetails
OPENAwaiting the assignee's action — the only status ever listed here
DONEResolved as completed
DECLINEDResolved as declined
DISMISSEDResolved as dismissed

A task is not cleared by the Delete API; the assignee resolves it via PATCH /api/v1/user/notifications/{id}. Resolved tasks no longer appear in this list. On every resolution the assigner receives an activities (ON_READ) notification reporting the outcome.

Responses​

List of user notifications