Custom notification rules
A rule that sets the audience and content of system notifications.
- API name:
notificationrules - Domain: Notifications
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text I18n | ||
| Title | title | Text Area I18n | ||
| Module | moduleUid | Constant | Yes | Product module that owns or scopes this row. |
| Entity | entityId | Reference | ||
| Table | tableUid | Constant | Yes | Business table this row points to. |
| Event | event | Constant | Optional. Leave empty to match every event of the table (actions and declared events). When set, the template only fires for that event. | |
| Roles | roleIds | References | ||
| Recipients | recipients | Data | Optional. Send to the user in this field on the event row (for example userId on tasks). When set, roles can stay empty. | |
| Body | body | Text Area I18n | ||
| Link (URL) | href | Text | ||
| Condition | condition | Button | Optional filters evaluated against the event payload. When empty, the template always matches. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area I18n | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Actions
What you can do with a record. Every action also sends the webhook event notificationrules.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new notification rule. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this notification rule. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this notification rule from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this notification rule to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this notification rule and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |