Types

Notification

A notification in a user's inbox.

idrequired
integer
The notification id. Notifications keep the integer ids they have always had.
titlerequired
string
The headline, with the platform's own wording substituted when it is read.
urlrequired
string | null
Where the notification leads, a path on the platform, or null when it leads nowhere.
is_downloadrequired
boolean
Whether the url is a document to download rather than a page to open.
statusrequired
string
unread until the user reads it. mark-read and mark-unread move it.One of: unread, read
read_atrequired
string | null (date-time)
When the notification was marked read. Null while it is unread.
actioned_atrequired
string | null (date-time)
When the user acted on the notification in the platform. Read-only: the API cannot set it.
created_atrequired
string (date-time)
When the notification was sent.
updated_atrequired
string | null (date-time)
When the notification last changed.

Used by (3)