Notification variables
Summarize
Summary of Notification Variables
Notification variables in ServiceNow are used to insert dynamic content into notifications, such as field values, links to records, or system preferences. This allows for more personalized and relevant communication with users.
Show less
Key Features
- Syntax: Use the format ${variable-name+variable-parameters} to specify notification variables. The variable-name is mandatory, while variable parameters are optional based on availability.
- Available Variables:
- ${field-name}: Displays the value of a specified field.
- ${image-field-name}: Displays an image linked to a record.
- ${URI} and ${URIREF}: Provide links to the current record; URI uses the word "LINK," while URIREF uses the record's display value.
- ${reference-field.URI} and ${reference-field.URIREF}: Link to records listed in reference fields, similar to URI variables.
- ${CMSURI}: Links to a specified record within a CMS page.
- ${notification:body}: Displays the body content of an email template.
- ${mailscript:script-name}: Executes a specified mail script.
- ${NOTIFUNSUB}: Links to unsubscribe from notifications.
- ${NOTIFPREFS}: Links to set notification preferences.
- ${comments:n}: Displays the last 'n' comments made on a record.
- ${commentsandworknotes:n}: Displays the last 'n' comments and work notes made on a record.
Key Outcomes
By utilizing notification variables, ServiceNow customers can create more effective notifications that provide relevant information to users, enhance user engagement, and streamline communication within the platform. Customers can expect improved clarity and personalization in their automated messages, leading to better user experiences. Examples demonstrate how these variables can be effectively rendered in notifications, helping customers understand their practical application.
Use notification variables to display dynamic information in the body of a notification such as a field value, a link to a record, or a link to system preferences.
Syntax
Specify a notification variable using this syntax:
${variable-name+variable-parameters}
The variable-name portion is always required. Not all notification variables support the variable-parameters portion. When available, most variable parameters are optional. See the list of available notification variables for variable names and available parameters.
Available variables
The system provides these notification variables.
| Variable | Description | Available parameters |
|---|---|---|
| ${field-name} | Display the value of the specified field. | None |
| ${image-field-name} | Display an image associated with a record. This variable is typically used with HTML to specify the source of an image element. | None |
|
Display a link to the current record.
Note: These variables don't apply to records in Workspace. To link to a
record in Workspace, create a mail script that prints a URL to a
notification. For more information, see Linking to a record in Workspace. |
Any valid sysparm URL parameter. For example:
|
|
Display a link to the record listed in a reference field.
|
Any valid sysparm URL parameter. For example:
|
| ${CMS_URI} | Display a link to the specified record within a CMS page. | <CMS-site>/<CMS-page>: The required relative path to the CMS page. |
| ${notification:body} | Display the body contents of an email template or email notification. Use this notification variable to specify where to display body content in an email layout. | None |
| ${mail_script:script-name} | Run the specified mail script. | None |
| ${NOTIF_UNSUB} | Display a link unsubscribe from this notification. | link_text: specify the text to display as a link within quotation marks. |
| ${NOTIF_PREFS} | Display a link to set notification preferences. | link_text: specify the text to display as a link within quotation marks. |
| ${comments:n} | Display the most recent comments that were made on the target record. The number of
comments to display is n. For example, To display all comments, use the variable |
Any number greater than 0. |
| ${comments_and_work_notes:n} | Display the most recent comments and work notes that were made on the target record. The
number of comments and work notes to display is n. For example,
To display all comments and work notes, use the variable
|
Any number greater than 0. |
Examples
| Variable | Example |
|---|---|
| ${field-name} | Source: Output: Incident INC1000001 - comments added |
| ${image-field-name} | Source: Output: |
|
${URI} Source: ${URI} Output: ${URI_REF} Source: ${URI_REF} Output: |
|
Source:
Output: |
| ${CMS_URI} | Source: Output: a link to a target CMS page such as |
| ${notification:body} | Source: Output: |
| ${mail_script:script-name} | |
| ${NOTIF_UNSUB} | |
| ${NOTIF_PREFS} |