Notification Rules
Notification rules are set up in such a way that when conditions are met or some event happens, the emails are sent to interested parties.
You can create new notification rules, or modify existing ones.
Role required: notification_admin.
Create a rule
To create a notification rule, complete the steps below:
- Navigate to System Notification → Notification Rules.
- Click New and fill in the fields.
- Click Save or Save and exit to apply the changes.
You can also create a notification rule through a form or a related list:
- Open the burger-menu .
- Select Configure → Notification Rules.
- Click New and fill in the fields.
- Click Save or Save and exit to apply the changes.
Notification Rule form fields
- General
- When to Send
- Who will Receive
- What will Contain
Field | Mandatory | Description |
---|---|---|
Name | Y | Specify a notification rule name. |
Table | Y | Select the target table for notifications. For example, to create a notification for some incidents, select the Incident table. |
Active | N | Select this checkbox to activate the notification rule. |
Inherited | N | Select this checkbox to apply this notification rule to child tables of the selected table. For example, if you select the Task table, this rule is also applied to the Incident, Problem, and other child tables of this table. |
Field | Mandatory | Description |
---|---|---|
Send when | Y | Specify when the notification should be sent. Available choice options:
|
Inserted | N | Select this checkbox to send the notification when a record is inserted into the Table. |
Updated | N | Select this checkbox to send the notification when a record is updated in the Table. |
Event register | Y | Specify an event. It is used by the system to register when specified conditions are met and to take some actions in response to the conditions. This field appears when the Event is fired option is selected in the Send when field. |
Conditions | N | Specify conditions to meet before sending the notification. Use the condition builder to build a filter that meets all the necessary requirements. An empty condition always returns true. |
Field | Mandatory | Description |
---|---|---|
Other recipients | N | Add contacts who will receive the notification. Available values in this field:
${current.caller.personal_email} ; ${script:callerManagerEmail} Check your template strings before using them within the system. For example: |
Users | N | Select the users who will receive the notification within this rule. If a user's email is also specified in the Other recipients field, the system sends only one notification. |
Send to self | N | Select this checkbox to send the notification to a person that initiated notification sending if this person is in the recipient list. Otherwise, the notification initiator address will be excluded from the To field of the notification email. |
Exclude delegates | N | Select this checkbox to ignore the notification rule for delegates. |
Note that:
- Emails without a recipient's address (the To field is empty) are not sent. They are in the Ignored state.
- If the Send to self attribute is false, and the email has only the notification caller as a recipient, the notification rule creates an email with the Ignored state.
Field | Mandatory | Description |
---|---|---|
Subject | N | Enter a notification subject. Notification variables and placeholders are supported here. |
Notification template | N | Select a relevant notification template from the list. |
Message | N | Add a notification body in plain text. Notification variables and placeholders are supported here. |
Message HTML | N | Add a notification template in rich text format. This field supports HTML tags, placeholders, notification variables. You can also use notification variables ${URI} and ${URI_REF} here. Their usage is described in the Notification Templates article. |
The server-side business logic may not work for system tables if the creation or updating of records is initiated by the backend. For example, an Import Set record is created as part of loading an Import Source, or an Email is created as a result of a notification rule, and so on.
Example of tables for which server-side business logic may not work:
- Main Log (sys_log)
- Script Log (sys_log_script)
- Exception Log (sys_log_exception)
- Record Deletion Log (sys_record_deletion_log)
- Import Set (sys_import_set)
- Activity Feed Item (sys_activity_feed_item)
- Email (sys_email)
Use case
You need to configure a basic notification for the Employee table. When a new employee is added, all employees receive a notification.
To implement this logic, create the following notification rule:
Field | Value |
---|---|
Name | New employee |
Table | Employee |
Active | true |
When to Send tab
Field | Value |
---|---|
Send when | Record inserted or updated |
Inserted | true |
Who will Receive tab
Field | Value |
---|---|
Other recipients | company-group@example.com |
What will Contain tab
Field | Value |
---|---|
Subject | New employee in the ${current.department} department |
Message | ${current.display_name} is in our team! |