---
sourceDocument: Xanadu ServiceNow AI Platform Administration
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/platform-administration

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu ServiceNow AI Platform Administration

ft:clusterId :

    - platadm

bundleId :

    - platadm

workflow :

    - Platform


---

# Notification variables

# Notification variables {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

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.  
{#notification-variables__table_ojr_mjc_ww__entry__3}

| Variable | Description | Available parameters |
|-|-|-|
| ${<kbd class="ph userinput">field-name</kbd>} | Display the value of the specified field. | None |
| ${<kbd class="ph userinput">image-field-name</kbd>} | Display an image associated with a record. This variable is typically used with HTML to specify the source of an image element. | None |
| * ${URI} * ${URI_REF} {#notification-variables__ul_emm_ntd_ww} | Display a link to the current record. * URI: The link text is the word `LINK`. * URI_REF: The link text is the display value of the record. {#notification-variables__ul_vbz_4td_ww} 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](https://servicenow-prod.fluidtopics.net/LuOL7DQglrhsx7bE_zjOgw#c_EnablingLinksToServiceNowRecords__link-to-workspace-record). | Any valid sysparm URL parameter. For example: * sysparm_scriptlet * sysparm_view {#notification-variables__ul_vcw_w4c_ww} |
| * ${<kbd class="ph userinput">reference-field</kbd>.URI} * ${<kbd class="ph userinput">reference-field</kbd>.URI_REF} {#notification-variables__ul_e2s_btd_ww} | Display a link to the record listed in a reference field. * URI: The link text is the word `LINK` * URI_REF: The link text is the display value of the record. {#notification-variables__ul_il2_gtd_ww} | Any valid sysparm URL parameter. For example: * sysparm_scriptlet * sysparm_view {#notification-variables__ul_wy4_1rd_ww} |
| ${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:<kbd class="ph userinput">script-name</kbd>} | 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, `${comments:3}` displays the last three comments that were made to the record. To display all comments, use the variable `${comments}`. | 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, `${comments_and_work_notes:3}` displays the last three comments and work notes that were made to the record. To display all comments and work notes, use the variable `${comments_and_work_notes}`. | Any number greater than 0. |
[Table 1. Available notification variables]

{#notification-variables__table_ojr_mjc_ww}

## Examples {#notification-variables__section_jxt_l33_53b}

Refer to the following examples to see how each notification variable is rendered in the output:{#notification-variables__table_kpc_n33_53b__entry__2}

| Variable | Example |
|-|-|
| ${<kbd class="ph userinput">field-name</kbd>} | Source: `Incident ${number} - comments added` Output: Incident INC1000001 - comments added |
| ${<kbd class="ph userinput">image-field-name</kbd>} | Source: `<img src='${picture}?t=medium'/>` Output: |
| * ${URI} * ${URI_REF} {#notification-variables__ul_nsl_s33_53b} | ${URI} Source: `Click here to view incident: ${URI}` ${URI} Output: ![Example that shows how the link text word Link serves as the link to the current record]() ${URI_REF} Source: `Click here to view incident: ${URI_REF}` ${URI_REF} Output: ![Example that shows how the link text displayed is the value of the record]() |
| * ${<kbd class="ph userinput">reference-field</kbd>.URI} * ${<kbd class="ph userinput">reference-field</kbd>.URI_REF} {#notification-variables__ul_ssl_s33_53b} | Source: Click here to view Incident: ${URI_REF} Click here to view Related Problem: ${problem_id.URI_REF} Output: |
| ${CMS_URI} | Source: `${CMS_URI+ess/incident_detail}` Output: a link to a target CMS page such as `https://<instance name>.service-now.com/ess/incident_detail.do?sysparm_document_key=incident,46e18c0fa9fe19810066a0083f76bd56` |
| ${notification:body} | Source: Output: |
| ${mail_script:<kbd class="ph userinput">script-name</kbd>} | Source: Output: |
| ${NOTIF_UNSUB} | Source: Output: |
| ${NOTIF_PREFS} | Source: Output: |
[ ]

{#notification-variables__table_kpc_n33_53b}

