v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Notifications

Create a notification

Creates a notification.

post/notifications

staffIdstring nullable

Staff id to notify.

iconstring nullable

The icon to display for the notification.

Will be validated against the Smokeball icon sets.

iconColorstring nullable

The icon hex color to display for the notification.

messagestring nullable

The message to display for the notification.

Supports basic markdown syntax, such as: ** bold **, -- italic --

Supports basic UI markdown syntax for staff member id, such as [@staffId]

toastyIconstring nullable

The toast notification icon to display for the notification.

toastyMessagestring nullable

The toast notification message to display for the notification.

actionUristring nullable

The Smokeball uri to execute when the notification is clicked.

{
  "staffId": "832e778f-83df-454a-b344-768a862a7e67",
  "iconColor": "#25C9A4",
  "message": "[@staffId] has **assigned** you a Task."
}

When request is accepted. Returns a 'Link' object.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable