Templates: Batched issue notifications and other events
This page is for default Jira notifications that are using batched issue updates
If you’re using separate issue notifications, check out this guide: Separate issue notifications.
Not sure which notifications you’re using? Learn more about different notification types
The ZIP archive that you downloaded from Jira contains templates from all available configuration options. It’s easy to get lost in the files and their dependencies, especially since not all of them apply to your configuration. Use this page to understand the templates and the notifications they control.
Definitions
You’ll often find two definitions in this guide: templates and includes. Since all of them are Velocity templates, here’s the best way to understand them:
Templates: Basically, these are notifications that you’re getting on email. If you want to customize the looks of a specific notification, you should modify a template.
Includes: They aren’t used on their own and are always referenced in templates. If you want to customize the looks of an item reused in multiple templates (changing footers or headers), you should modify the include.
Some of the templates contain includes or content parsed from other templates. You might need to customize those files as well. Use the Includes and Parsed templates columns to check if a template has any content that you’ll need to adjust additionally.
Issue notifications
Templates
If you want to customize a notification that contains information about Jira issues (summary emails), you’ll need to adjust the files listed in the following table.
Directory: templates/email-batch/html
| Name | Description | Includes | Parsed templates |
|---|---|---|---|
| IssueUpdateBatcher-subject.vm | Email subject for batched issue updates. | - | - |
| IssueUpdateBatched-header.vm | Email header. It contains:
| - | - |
| IssueUpdateBatcher-content.vm | Main part of the email where issue updates are shown. The updates themselves, however, are retrieved by the next template (below), which is included in this one. |
|
|
| IssueUpdateBatcher-history.vm | Provides the summary of issue updates: comments, updates, work logs, mentions, and issue status (moved, assigned, archived, deleted, etc.). | - |
|
Includes
If you want to customize some parts of a template’s look or content, you might need to adjust the files from the folllowing table, which are referenced in templates for issue notifications.
Directory: templates/email-batch/html
Other notifications
These notifications control other events like notifications about shared filters or ones related to user management. Learn more about different notification types
Patterns
It’s unlikely that you’ll need to edit any of the pattern templates. They contain reusable components that are common for the Jira UI, like action buttons, titles, or text paragraphs. If you want to check them out anyway, you can find them in templates/email/html/patterns.
Share templates
If you want to customize a notification that’s sent when someone has shared an issue, search query, or filter with a user, you’ll need to adjust the files listed in the following table.
Directory: templates/email/html
| Name | Description | Includes | Patterns | Parsed templates |
|---|---|---|---|---|
| share-issue.vm | Someone is sharing an issue with you. |
|
|
|
| share-jql-search.vm | Someone is sharing a JQL search with you. |
|
|
|
| share-saved-search.vm | Someone is sharing a saved search (filter) with you. |
|
|
|
Contact admin templates
If you want to customize a notification related to the admin-user communication, you’ll need to adjust the files listed in the following table.
Directory: templates/email/html
| Name | Description | Includes | Patterns |
|---|---|---|---|
| contactadministrator.vm | Notification that Jira admin is getting after someone tries to contact them over the Contact Admin form. |
|
|
| emailfromadmin.vm | Emails sent to users directly from the Jira admin. |
|
|
User management templates
If you want to customize notifications sent after user account setup, password reset, and similar, you’ll need to adjust the files listed in the following table.
Directory: templates/email/html
| Name | Description | Includes | Patterns |
|---|---|---|---|
| usercreated.vm | New user was created. Notification for Jira admins. |
|
|
| usercreated-nopassword.vm | New user was created in an external directory, and their password can’t be changed. Notification for Jira admins. |
|
|
| usersignup.vm | Notification users receive after signing up to Jira. |
| - |
| forgotusername.vm | Notification users receive if they forget their usernames. |
| - |
| forgotpassword.vm | Notification users receive if they forget their password. |
| - |
Includes in other notifications
The following table shows the list of includes referenced in main templates. It doesn’t contain includes used in templates for issue notifications, those are referenced in the Issue notifications section.
Directory: templates/email/html/includes