Email This Issue
📈 Marketplace❓ Support❤️ Feedback🏠 META-INF Apps
Email This Issue - for Jira Server/Data Center
Email This Issue - for Jira Server/Data Center
  • ⬇️Start Here
  • Email This Issue - for Jira Server/DC
  • Features
  • Secure the email channel with Email This Issue
  • Comparing Email This Issue and Jira Server/DC
  • 🤓Documentation
    • Outgoing Emails
      • Sending manual emails
        • The difference between email editors
        • Enabling template categories so templates can be chosen on the Email screen
        • Mail Generation Queue (formerly called Event Queue)
        • Manual Email Default Settings
      • Sending issue filters by email
      • Email templates
        • Adding custom macro to email templates
        • Adding Email Audit Log to email templates
        • Adding fields to email templates
        • Adding issue comments to emails
        • Adding issue link information to your template
        • Adding issue operation links to the email
        • Adding a signature with a company logo to emails
        • Adding user properties to emails
        • Disabling links and avatars or icons in templates
        • Formatting Date and Time values
        • Using reply templates
        • Using Mail Body Initializer templates
        • Rendering templates within templates
        • Velocity Context in email templates
        • Formatting number values
        • Searching for issues in email templates
        • Changelog information in email templates
        • Canned responses
      • Contexts
        • Context Resolution Algorithm
      • Event Notifications
      • Distribution lists
      • Workflow post functions
      • Custom fields
    • Incoming Emails
      • Attachment Filtering
      • Next Generation Mail Handlers
        • Jira automation and Next Generation Mail Handlers
        • Using regular expressions
      • Classic Mail Handlers - Deprecated
        • Mail Handler Error Log
        • Step-by-step Classic Mail Handler to Next Generation Mail Handler migration aid
        • Field Rules
        • Phasing out the Classic Mail Handler
        • Comparing the Classic and the Next Generation Mail Handlers
    • Integrations
      • CRM for Jira
      • nFeed
      • Glass Documentation
      • API - Integration with other services
    • Administration
      • General configuration
      • Email Audit Log
      • Outgoing Mail Connections
      • Outgoing Mail Queue
      • Incoming Mail Connections
      • Incoming Mail Queue
      • Incoming Mail Log
      • Backup and restore settings
        • Backup and restore administration
          • Backup menu
          • Restore menu
        • Backup and Restore Tutorials
          • Backup and restore for empty email settings
          • Backup and restore only parts of a configuration
          • Backup and restore every setting in the same instance
      • OAuth2 Authorizations in Email This Issue
        • OAuth2 Client Credentials
        • Authorizing Email This Issue to access Gmail accounts
        • Authorizing Email This Issue to access Microsoft 365 accounts
        • Enabling OAuth2 Authorization in your Google Account
        • Enabling OAuth2 authorization in your Microsoft 365 account
        • Troubleshooting guides for Microsoft OAuth2 Connections
          • How to fix "Authorization Was Interrupted" error
          • How to fix "BAD User is authenticated but not connected" error
          • How to fix "401 Unauthorized" error
          • How to fix "key expires_in " error
          • How to fix "Need admin approval" error
      • Alerting via Webhooks
        • Webhooks
          • Configuring Slack to receive webhooks
          • Configuring OpsGenie to receive webhooks
        • Webhook execution logs
      • Email Security
    • Service management integration
    • JQL Functions
    • Top-level menu navigation
  • ☁️Server to Cloud Migration
    • Server to Cloud - Automatic Migration tool
    • Server to Cloud - Manual migration guide for Email This Issue
      • Overview of available features
      • Differences of the Server and Cloud user interface
      • Migrating Outgoing Settings
        • Migrating Templates
        • Migrating Notifications
        • Migrating Manual Email Defaults
        • Migrating Contexts
        • Migrating Canned Responses
        • Migrating Post Functions
        • Migrating Outgoing Mail Connections
      • Migrating Incoming Settings
        • Migrating Classic Mail Handlers
        • Migrating Next Generation Mail Handlers
        • Migrating Incoming Mail Connections
        • Migrating Incoming Mail Queue Settings
        • Migrating Incoming Mail Log Settings
      • Migrating Other Settings
        • Migrating OAuth2 Credentials
        • Migrating global default email settings
        • Migrating permissions for sending emails manually
        • Migrating recipient restrictions
  • ❓FAQ
    • FAQ
      • How to bypass workflow conditions
      • How to avoid email loops
      • How to control who to send emails to
      • How to customize Email From in outgoing emails
      • How to enable logging
      • How to install license keys
      • How to find out why the Email button is missing
      • How to obtain a community or non-profit license
      • How to prevent duplicate emails
      • How to remove old content from reply emails
      • How to send personalized emails to recipients
      • How to set up auto-reply or acknowledgment emails
      • How to track cases when you don't get any emails
      • How to view the log of incoming and outgoing emails
      • The iOS Mail app does not show attachments
      • How to route emails to projects
      • How to maintain email threads in Jira
      • How to fix issues with a corrupt index state
      • How to set polling interval for mail accounts manually
    • Tutorials
      • Configuring email approval
      • Customizing the email template used with manual emails
      • Enhance Jira Service Management with Email This Issue
      • Getting Started
      • Setting up an Email Help Desk
      • Setting up customized notifications
      • Setting up a Service Management with a Next-Gen Mail Handler
  • 🌪️Misc
    • Open Source Components
    • Pricing Updates
      • Pricing Update effective October 1st 2018
      • Pricing Update effective December 1, 2021
    • End of Support Policy
    • Security Advisories
      • Email This Issue Security Advisory 2020-02-18
    • Database Tables
    • Translations
  • 🆕Release Notes
    • Release notes
      • 9.x.x
        • 9.15.0 Jira 10 compatibility
        • 9.13.0 Improvements and Fixes
        • 9.11.0 Improvements and fixes
        • 9.10.0 Major improvements and fixes
        • 9.9.1 Improvements and fixes
        • 9.9.0.2 Major improvements and fixes
        • 9.8.0 Improvements and fixes
        • 9.7.0 Improvements and fixes
        • 9.6.0 Improvements and fixes
        • 9.5.0 Improvements and fixes
        • 9.4.0 Bugfixes
        • 9.3.3. Improvements and fixes
        • 9.3.2 Major improvements
        • 9.3.1 Automatic cloud migration
        • 9.2.2.1 Bugfixes
        • 9.2.2 Improvements and fixes
        • 9.2.1.3 Compatibility changes for Jira 9.0.0
        • 9.2.1 Major improvements
        • 9.2.0 Improvements and fixes
        • 9.1.1 Improvements and fixes
        • 9.1.0.1 Alerting and other major new features
        • 9.0.2 Bugfixes, next step in deprecating the Classic Mail Handler
        • 9.0.1 Minor improvement and fixes
        • 9.0.0 Major improvements
        • 9.12.0 Improvement and fixes
        • 9.17 Improvements and Fixes
        • 9.18.0 Improvements and fixes
      • 8.1.x
        • 8.1.3 Classic handler is deprecated, timezone support, bug fixes
        • 8.1.2 Important bug fixes
        • 8.1.1 Microsoft 365 OAuth2, improvements and fixes
        • 8.1.0 Microsoft 365 OAuth2, improvements and fixes
      • Up to 8.0.6
Powered by GitBook
On this page
  • Event notifications in Jira
  • Event notifications in Jira Email This Issue
  • Adding and editing notification templates
  • Sending customized notifications to different recipients
  • Adding an event notification to a notification template
  • Mapping Notification Templates to Scopes in the Contexts

Was this helpful?

  1. Documentation
  2. Outgoing Emails

Event Notifications

PreviousContext Resolution AlgorithmNextDistribution lists

Last updated 1 year ago

Was this helpful?

Event notifications in Jira

Event Notifications are automated emails that are sent when triggered by events. It is as easy to set up Email This Issue notifications as it is to set up Jira Project Notification Schemes, but our built-in solution offers more than Jira's. Event Notifications are grouped in Notification Templates. These groups contain event notifications that may be triggered altogether or separately.

Jira notifications are more difficult to customize and Jira does not support different mail templates per project, issue type, or event. They do not allow you to address notification emails to external email addresses stored in custom fields, and they do not allow adding attachments to the outgoing emails.

Event notifications in Jira Email This Issue

Jira Email This Issue allows you to do the following:

  • Develop different templates for any combination of project, issue type, and event.

  • Address notification emails to external external recipients without access to your Jira instance.

  • Configure customizable notification schemes (notification templates).

  • Add issue attachments to outgoing notification emails.

  • Send different emails to different recipients upon a single event.

  • Configure Service Management Customer Notifications separately to Event Notifications

Notification templates are not connected to certain scopes by default; they need to be mapped to Contexts.

There are four steps to setting up a set of notifications:

  • Create customizable email templates in Email This Issue (this is not a notification template, this is the look-and-feel of your outgoing email.) Read more about email templates .

  • Add a notification template (i.e. notification scheme).

  • Configure the notifications based on events within the notification template (these are the events that the outgoing email will be triggered by, such as 'Issue updated' or 'Issue created').

  • Map the notification template to a project, issue type, JQL, or a combination of these in the Context settings. Read more .

Adding and editing notification templates

1. Go to OUTGOING EMAILS --> Notifications. Notification templates are listed here with their name, description, and the Event Processor setting.

2. Click the Add button to create a new notification template.

Field
Value

Name

Name of the notification template.

Description

A description of the notification template (Optional).

Event Processor

3. Alternatively click the three dots next to the name of the template, and choose one of the following operations:

Operation
Description

Edit

Edit the notification template.

Event Notifications

Show the event notifications and customer notifications of the notification template.

Copy

Copy the notification template with all events and their configurations.

Delete

Remove the notification template with all its events. Cannot be reversed, if unsure, please use the Disable button.

Disable

Temporarily disable the notification template, preventing any event notifications within this group to be sent out.

Sending customized notifications to different recipients

Notification templates have the following operation modes:

  • Processing the first matching event notifications

  • Processing all matching events notifications

Event Processor
Description

First Matching Event

For an event fired in Jira, find the first (best) matching event notification by

  • the type of events

  • the JQL filter (if any)

  • the changelog filter (if any)

If an event notification matches the issue event details, an email is sent to the recipients using the email template.

All Matching Events

In this case, the Notification Template processes all event notifications and customer notifications that matches by

  • the type of events

  • the JQL filter (if any)

  • the changelog filter (if any)

Emails for all matching event notifications will be sent to the recipients configured within.

In case you want to send different emails to different recipients for the same issue event you may try to configure notification based on the following example.

  • Configure your Notification with Event Processor = All Matching Events

  • Add all event notifications upon which you want to send emails

  • Add the same event type for all the emails you want to send.

In this example, we would like to send two notifications:

  • One event notification for the Issue Created event, where the recipient is the Reporter and the MC Issue Created email template is used upon an issue creation.

  • One event notification for the Issue Created event, where the recipient is the Assignee and the MC Issue Created email template is used upon an issue creation.

Note: If the Event Processor is set to "First matching event", only the first notification is sent. In the case of our example the Event Processor is set to "All matching events", so both notification emails are sent out.

Adding an event notification to a notification template

Event Notifications map issue events to email recipients and email templates, and they specify additional email content: Subject and Body.

1. Click the name of the notification template you want to add notifications to, or click the three dots and choose Event Notifications.

2. Create an event notification by clicking on the Add button and selecting one of the following notification types:

  • Issue Notifications: can be sent to any recipient without any restrictions.

  • Service Management Customer Notifications: can be sent to customers and external email addresses only (not to licensed users of any kind).

Issue Notifications

Issue Notifications can be sent to any recipients and are not based on Service Management Customer notifications at all. After adding your event, or events if you want to have the same notification for multiple events, you can configure it with an email template, add recipients to it, specify additional email content, and email settings.

Configure the following while creating a notification:

  • Specify the event(s) that trigger the notification, choose a template to send in the email and optionally give it a description and an order.

  • Set the conditions that apply to the notification. If any conditions are set here, the notification will only be sent if all of them are met.

  • Specify the content which may be added to the template, such as the email subject or body.

  • Select which attachments to add to the outgoing email.

  • Choose from various email settings to specify additional options applicable to your outgoing email.

Note: By default, Email This Issue respects the profile setting "My changes: do not notify me". This means that the current user performing an action in Jira may not get event notifications on their own actions. To override it, you can enable the option "Always notify recipients" in the Email This Issue event notification.

Service Management Customer notifications

Customer Notifications are based on Service Management Request Events in contrast to regular Issue events. Service Management Customer Notifications can only be sent to customers and external email addresses (not to users of any kind).

Service Management Request Events that are currently supported in our app:

SD Request Event
Description

Request Created

The event is fired when a Service Management request is created.

Request Updated

The event is fired when a Service Management request is modified.

Request Resolved

The event is fired when a Service Management request is resolved.

Request Reopened

The event is fired when a Service Management request is reopened.

Public Comment Added

The event is fired when a Service Management request receives a public comment.

Customer Visible Status Changed

The event is fired when the status changes in a request noticeably in the Customer Portal.

Configure the following while creating a Service Management Customer notification:

  • Specify the event(s) that trigger the notification, choose a template to send in the email and optionally give it an order.

  • Set the conditions that apply to the notification. If any conditions are set here, the notification will only be sent if all of them are met.

  • Specify the content which may be added to the template, such as the email subject or body.

  • Select which attachments to add to the outgoing email.

  • Choose email settings to specify additional options applicable to your outgoing email.

Note: By default, Email this issue respects the profile setting "My changes: do not notify me". This means, that the current user performing an action in Jira may not get event notifications on their own actions. To override it, you can enable the option "Always notify recipients" in the Email This Issue event notification.

Note: If you combine Issue Event Notifications with Customer Notifications, please set the Notification to "All Matching Event" to make sure both users and customers receive their notifications.

Mapping Notification Templates to Scopes in the Contexts

Once your notification template is set up with event notifications, email templates, and recipients, you must map it with a scope. If you miss this one step, your notifications will not be sent. Navigate to OUTGOING EMAILS --> Contexts. Choose the context you'd like to edit and select your notification template under Notifications in the Notification field's drop-down menu.

Result: The notifications are configured and will be sent according to your configurations.

Notification templates have two operation modes: processing the first matching event notification or all matching ones. Read more .

Add the TO and CC recipients. They have to be added here. BCC is only available if enabled in the General Configuration. Read more .

Add the TO and CC recipients. They have to be added here. BCC is only available if enabled in the General Configuration. Read more .

🤓
here
here
here
here
here