get_notification_list
Get all scheduled notification configurations for this tenant. Notifications send items matching conditions to user groups, email, Slack, Teams, or HTTP endpoints at configured intervals.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigNotification objects with notification details including ID, name, description, interval, and active status.
create_notification
Create a new scheduled notification configuration.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Notification name. |
description | string | No | — | Notification description. |
interval | int | No | 180 | Interval in minutes between notifications (default 3 hours). |
active | bool | No | true | Whether the notification is active. |
Returns
The createdConfigNotification. Requires super admin.
update_notification
Update an existing notification configuration. Only provided fields are updated.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
notificationId | string | Yes | The notification ID. Use get_notification_list. |
name | string | No | New notification name. |
description | string | No | New description. |
interval | int | No | New interval in minutes. |
active | bool | No | Enable or disable the notification. |
Returns
The updatedConfigNotification. Requires super admin.
delete_notification
Delete a notification configuration.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
notificationId | string | Yes | The notification ID. Use get_notification_list. |