Share:
ClickHelp Documentation

Email Notification Templates

 

Email notification templates are HTML files with predefined markup used to generate the subject text and the body content of the notification message that the system sends to your Authors, Reviewers, and Power Readers upon various events described below. You can learn how to customize email notification templates here: Email Notification Templates Customization.

Email notification template files are located in the /Storage/Templates/Emails folder, and their names look like this: CreateUserTemplate.en-US.html.

The List of Email Notification Template Files

Here you'll find a description of all email notification template files with lists of placeholders used in them.

Email notification template file
Description
Placeholders for the <head> tag Placeholders for the <body> tag
ArticleAssignedToChangeTemplate.en-US.html
Sent when assignee of a single topic is changed
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{USER_PROFILE_URL}}
ArticleAssignedToMultiChangeTemplate.en-US.html Sent when assignee of multiple topics is changed
{{TOPIC_COUNT}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_COUNT}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{USER_PROFILE_URL}}
ArticleReviewCommentAddTemplate.en-US.html Sent when a review comment in a topic is added {{TOPIC_ID}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{COMMENT_HOTSPOT}}, {{COMMENT_DETAILS}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{TOPIC_URL}}, {{USER_PROFILE_URL}}
ArticleReviewCommentDeleteTemplate.en-US.html Sent when a review comment is deleted in a topic
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{COMMENT_HOTSPOT}}, {{COMMENT_DETAILS}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{TOPIC_URL}}, {{USER_PROFILE_URL}}
ArticleReviewCommentResolveTemplate.en-US.html Sent when a review comment is resolved in a topic
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{COMMENT_HOTSPOT}}, {{COMMENT_DETAILS}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{TOPIC_URL}}, {{USER_PROFILE_URL}}
ArticleStatusChangeTemplate.en-US.html Sent when the status of a single topic is changed
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{USER_PROFILE_URL}}
ArticleStatusMultiChangeTemplate.en-US.html Sent when the status of multiple topics is changed
{{TOPIC_COUNT}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_COUNT}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{USER_PROFILE_URL}}, {{TOPIC_STATUS_COLOR}}, {{TOPIC_STATUS}}
ArticleToDoItemAddTemplate.en-US.html
Sent when a ToDo item is added for a topic
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{USER_PROFILE_URL}}
ArticleToDoItemDeleteTemplate.en-US.html
Sent when a ToDo item is deleted for a topic
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{USER_PROFILE_URL}}
ArticleToDoItemDoneTemplate.en-US.html
Sent when a ToDo item is marked as "done" for a topic
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{USER_PROFILE_URL}}
ChangePasswordTemplate.en-US.html Sent after changing the password from the profile page
{{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{NEW_PASSWORD}}
CreateUserTemplate.en-US.html Sent when a new user is created via API or Author UI
{{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_LOGIN}}, {{PASSWORD}}
OfficialMasterTemplate.en-US.html
The master template that used as a base for all other templates

{{CONTENT}}
ResetApiKeyTemplate.en-US.html Sent when an author with the administrator role reset the API key on their profile page
{{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{API_KEY}}
ResetPasswordConfirmTemplate.en-US.html Sent when the password is reset from the Forgot Password page {{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{PASSWORD_RESET_URL}}
ResetPasswordTemplate.en-US.html Sent when the password is reset from a user's profile
{{USER_FIRST_NAME}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{NEW_PASSWORD}}
TransAssignedToChangeTemplate.en-US.html
Sent when assignee of a translation document is changed
{{TRANS_ID}}
{{USER_FIRST_NAME}}, {{TRANS_URL}}, {{TRANS_NAME}}, {{PROJECT_NAME_HTML}}, {{TRANS_STATUS_COLOR}}, {{TRANS_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}
TransStatusChangeTemplate.en-US.html
Sent when the status of a translation document is changed
{{TRANS_ID}}
{{USER_FIRST_NAME}}, {{TRANS_URL}}, {{TRANS_NAME}}, {{PROJECT_NAME_HTML}}, {{TRANS_STATUS_COLOR}}, {{TRANS_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}

The List of Available Placeholders

According to the table above, each email notification template file may have specific placeholders in Mustache format replaced with particular content in the final message. Below, you'll find a complete list of placeholders available with their short descriptions.

Placeholder
Description
{{ACTION}}

A description of the action performed.

For example
When someone adds a review comment (the ArticleReviewCommentAdd template), this placeholder will be replaced by the following text: A review comment has been added to a topic.

{{API_KEY}} The generated API key
{{COMMENT_HOTSPOT}} The text content of the review comment
{{COMMENT_DETAILS}} More detailed information about the review comment, including the text content of the comment, the link to the profile of a user who made the action, and the date and time of action
{{CONTENT}} Used only in the OfficialMasterTemplate.en-US.html file and replaced by the content of the sent notification
{{MODIFIED_BY_USER_PROFILE_URL}} The link to the profile page of a user who made the changes
{{MODIFIED_BY_USER_PROFILE_HTML}} The link to the profile page of a user who made the changes with the avatar picture near it
{{NEW_PASSWORD}} The new password for a user
{{PASSWORD}} Password for the created user
{{PASSWORD_RESET_URL}} The link for the password reset
{{PROJECT_NAME}} The name of a project/publication where the changes have been made
{{PROJECT_NAME_HTML}} The name of a project/publication where the changes have been made, which comes in the form of the link to the project/publication
{{PROJECT_URL}} The link to a project/publication where the changes have been made
{{SENT_FROM_URL}} The URL of a portal from which the message is sent
{{TODO_ITEMS_LIST}} The ToDo items list for a topic where the changes have been made
{{TOPIC_COUNT}} The number of affected topics
{{TOPIC_ID}} The ID of a topic where the changes have been made (you can learn about what is topic ID here: Create a Topic
{{TOPIC_STATUS}} Workflow status of a topic where the changes have been made
{{TOPIC_STATUS_COLOR}} Workflow status color of a topic where the changes have been made
{{TOPIC_TITLE}} The title of a topic where the changes have been made
{{TOPIC_URL}} The link to a topic where the changes have been made
{{TRANS_ID}} The ID of the translation document where the changes have been made (it will display the name instead of ID in case the translation document is not a topic)
{{TRANS_NAME}} The name of the translation document where the changes have been made
{{TRANS_STATUS}} Workflow-status of the translation document where the changes have been made
{{TRANS_STATUS_COLOR}} Workflow-status color of the translation document where the changes have been made
{{TRANS_URL}} The link to the translation document where the changes have been made
{{USER_FIRST_NAME}} The first name of a user to whom the message is sent
{{USER_LOGIN}} The login of a user to whom the message is sent
{{USER_NOTIFICATION_SETTINGS_URL}} The link to the Email Notifications section of profile settings of a user to whom the message is sent
{{USER_PROFILE_URL}} The link to the profile of a user to whom the message is sent