Notifications

Get notification

Get a notification by id.

get/api/notifications/{id}

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/notifications/{id}
  • Auth: none declared

Path parameters

idinteger required

Notification id.

Query parameters

trashedboolean

true to return notification even if trashed.

Response

OK

typeunknown
actionstring nullable

The type of action that triggered the notification.

templatestring nullable

Gets or sets the notification template string.

argsstring[] nullable

Gets or sets the arguments used to format string NotificationOut.Template into a (localized) string.

textstring nullable

Gets the formatted (and localized) notification text.

htmlstring nullable

Gets the notification text as html.

plainstring nullable

Gets the notification text as plain text.

tagsstring[] nullable

Gets or sets the tags for the notification.

metadataobject nullable
created_atstring date-time

Date and time (UTC) the notification was created.

updated_atstring date-time nullable

Date and time (UTC) the notification was last modified

is_unreadboolean nullable

If the notification is unread or not.

Changes

No recorded changes to this operation across all 1 revision of this API.