2017-10-02 06:18:10 +00:00
|
|
|
create:
|
2017-10-30 20:39:12 +00:00
|
|
|
description: Show a notification in the frontend.
|
2017-10-02 06:18:10 +00:00
|
|
|
fields:
|
|
|
|
message:
|
|
|
|
description: Message body of the notification. [Templates accepted]
|
|
|
|
example: Please check your configuration.yaml.
|
|
|
|
title:
|
|
|
|
description: Optional title for your notification. [Optional, Templates accepted]
|
|
|
|
example: Test notification
|
|
|
|
notification_id:
|
2021-01-15 11:13:56 +00:00
|
|
|
description: Target ID of the notification, will replace a notification with the same ID. [Optional]
|
2017-10-02 06:18:10 +00:00
|
|
|
example: 1234
|
|
|
|
|
|
|
|
dismiss:
|
2017-10-30 20:39:12 +00:00
|
|
|
description: Remove a notification from the frontend.
|
2017-10-02 06:18:10 +00:00
|
|
|
fields:
|
|
|
|
notification_id:
|
|
|
|
description: Target ID of the notification, which should be removed. [Required]
|
|
|
|
example: 1234
|
2019-09-03 23:02:42 +00:00
|
|
|
|
2019-04-19 13:14:48 +00:00
|
|
|
mark_read:
|
|
|
|
description: Mark a notification read.
|
|
|
|
fields:
|
|
|
|
notification_id:
|
|
|
|
description: Target ID of the notification, which should be mark read. [Required]
|
|
|
|
example: 1234
|