Notifications

Create notification

Sends a custom notification to the specified user.

post/api/notifications

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
Auth: none declared

userstring nullable required

User identifier (id or uid) of notification recipient.

textstring nullable required

The notification text. Numbered placeholders, e.g. "{0} commented on {1}", will be replaced with items in args when rendering the notification.

argsstring[] nullable

Arguments used to replace placeholders in text when rendering the notification.

tagsstring[] nullable

Tags to set on the notification. Tags can be used to filter notifications when listing.

metadataobject nullable

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

Created

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.

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