Slack-Jira Documentation

4.1.1. Channel tab

4.1.2. Filters tab

4.1.3. Events tab

4.1.4. Options tab

4.1.5. Message format tab

4.2.1. Channel Tab

4.2.2. Filters tab

4.2.3. Events tab

4.2.4. Options tab

4.2.5. Message format tab

4.3.1. Events tab

4.3.2. Options tab

4.3.3. Message format tab

5.2.1. Parameters

1. Slack-Jira Overview

 

The Jira Slack Integration provides bi-directional communication between the Jira Cloud instance and Slack.

 
You can find this app on the Atlassian Marketplace here: 

https://marketplace.atlassian.com/plugins/jiragitintegration/cloud/overview. 

Any change, comment or update within Jira can be configured to notify to one or multiple Slack channels. 


A Slack user can participate in a discussion around a Jira issue and that conversation is sent to Jira.   

Notifications

The Jira Slack Integration addon allows you to create notifications at three levels within Jira.  At a system level, a project level and an issue level.

System Notifications

System notification works at the system level, meaning any notification set up here responds to events within the whole Jira system and includes all projects and issues.   A user can create one or many notifications at a system level.  System level notifications can be created or configured on the System Level administration screen.  

Issue level notifications are shown as well, but cannot be created here.   

For more information please see Creating a System Notification

Project Notifications

Project notifications work at a project level, meaning any notification set up here responds to only events for that specific Jira project including all issues associated with the project. A user can create one or many notifications at a project level.

Project level notifications can be created or configured at the Project Level Administration screen.

Issue level notifications are also shown here and can be configured here as well.

For more information please see Creating a Project Notifications

Issue Notifications

Issue notifications work at an issue-level, meaning any notification set up here responds to only events within a specific issue.  A user can create one or many notifications at an issue-level.  

Issue level notifications can be created or configured on the Jira Issue Page.

For more information please see Creating an Issue Notifications

Slack Slash commands

This add-on supports a variety of slash commands inside Slack. To get a list, inside Slack type "/jira ?" after connecting your Slack instance to this add-on. 

For more information on this please see Slack Commands

2. Installation
 
2.1 Installation from Manage Add-Ons
 
  1. Log into your Jira instance as an admin.

  2. Click the admin dropdown and choose Add-ons.
    The Find new add-ons screen loads.

  3. Find Slack Jira Integration by Bitband via search.
    The appropriate add-on version appears in the search results.

  4. Click Install.

  5. Confirm add-on installation by clicking Accept & install.
    Now you're able to connect to Slack.

2.2 Installation from Atlassian Marketplace
 

Please note that only a Jira Administrator can Install this addon as this requires access to system preferences.

1. Log into your Jira instance as an admin.

2. Navigate to the Slack Jira Integration addon page and click on the “Get it now” button.

3. If you have multiple Jira sites with your account select the site you wish to install the addon to.

4. Select the  “Install” button to install the Slack Jira Integration.

5. Follow the prompts to install this addon.   

3. Connecting to Slack
 

It's HIGHLY recommended you create a dedicated Slack admin user that's solely used for connecting this app from Jira to Slack. If you use a Slack admin account that's actively used by someone they'll end up receiving some system notifications inside their Slack which could be a disruption of their daily workflow. 

Once you have installed the addon you will need to connect to your instance of Slack.  Please note that only a Jira/Slack Administrator should do this connection, otherwise functionality in this app will be limited. 

 

1. Log into your Jira instance as an admin.

2. From the Jira Dashboard click on Settings as shown below.

3. Click on Add-ons → Manage add-ons and Find  "Slack Integration" in the list of Add-ons.  Select the Config button.

4. Click on the "Sign in with Slack" button shown below and follow the prompt to select and login to your instance of Slack. .

5. Select appropriate Slack Team and Authorize.

6. Congratulations, now you’re able to use the Add-on! You can change your Slack account any time to any other account by disconnecting and reconnecting with a new account.

For more details check out this video:

4. Creating Notifications
 

You can create three levels of notifications that connect to a Slack channel:

  • System Notifications connecting to a Slack channel - provide event notifications for all Jira items and issues in all defined projects within your system.

  • Project Notifications connecting to a Slack channel - provide event notification for all Jira items and issues within a specific project.

  • Issue Notifications connecting to a Slack channel - provide event notification within a specific Jira issue.

4.1 Creating a System Notification for Slack
 

You can create a notification at a System-level that connects to one or more Slack channels.  Please note that only a Jira Administrator can do this as this requires access to system preferences.  

  1. Log into your Jira instance as an admin

  2. Open Slack Integration System channels Preferences
    Add-ons → Manage add-ons → Slack Integration → System channels

  3. Select “Create” as shown below

4.1.1 Channel Tab

The Channel tab allows you to configure which Slack Channel you wish to direct notifications.  You can send a notification to a new channel, an existing channel, or directly to a Slack user.

1. Add a channel name and channel topic. You can also optionally invite Slack users to this channel as shown below.

4.1.2 Filters Tab

The filters tab allows you to filter out which type of events you require.

Select one of the options:
 

  • No filter (all notifications will be sent)

  • Basic filter (you can create your own filter)

  • Advanced filter (JQL filter)

4.1.3 Events Tab

The Events tab allows you to monitor which events you wish to turn on notifications.

By default, all values are selected.

4.1.4 Options Tab

The option tab allows you to force all notifications to this channel regardless of any settings at the project or issue level. By default option is deselected.

Click Save to create a System channel.

4.1.5 Message format Tab

You can choose a “Message Format” for all your Notifications (System, Project, and Issue Notifications).   Go to the channel settings, “Message format” tab. List of Message Format includes a list of all issue fields and statuses.

Each field or status has a checkbox beside it. If a field or status is checked, then it will be shown at the bottom of the notification displayed in Slack. Example of Notifications:.

1. If Comment, Time spent and Status are selected, a sample notification in Slack will look as follows:

2. If Priority, Reporter and Type are selected a sample notification in Slack will look as follows:

4.2 Creating a Project Notification for Slack
 

You can create a notification at a Project level that connects to one or more Slack channels.

1. From the Jira Dashboard click on Project and select your desired Project.

2. From the list of menu options select "Slack Integration" as shown below.  

3. Select “Create” as shown below.

4.2.1 Channel Tab

The Channel tab allows you to configure which Slack Channel you wish to direct notifications.  You can send a notification to a new channel, an existing channel, or directly to a Slack user.

1. Select a project, add one of (1) Channel name (2) Existing channel or (3) Direct Channel, and Channel topic. You also have the option to invite Slack users to this channel as shown below.

4.2.2 Filters Tab

The filters tab allows you to filter out which type of events you require.

Select only one of the following options:

  • No filter (all notifications will be sent)

  • Basic filter (you can create your own filter)

  • Advanced filter (JQL filter)

4.2.3 Events Tab

The Events tab allows you to monitor which events you wish to turn on notifications for.

By default, all values are selected.

4.2.4 Options Tab

The options tab allows you to remove notifications to System channels and override any issue level notifications set.

 

By default options are deselected.

Click Save to create a Project channel.

4.2.5 Message format Tab

You can choose a “Message Format” for all your Notifications (System, Project, and Issue Notifications).   Go to the channel settings, “Message format” tab. List of Message Format includes a list of all issue fields and statuses.

Each field or status has a checkbox beside it. If a field or status is checked, then it will be shown at the bottom of the notification displayed in Slack. Example of Notifications:.

1. If Comment, Time spent and Status are selected, a sample notification in Slack will look as follows:

2. If Priority, Reporter and Type are selected a sample notification in Slack will look as follows:

4.3 Creating an Issue Notification for Slack
 

You can create a notification at an issue-level that connects to one or more Slack channels.

1. Open any Jira item and select "create" in the Slack Integration section as shown below.

.

2. Add a channel name and channel topic. You can also optionally invite Slack users to this channel as shown below. 

4.3.1 Events Tab

The Events tab allows you to monitor which events you wish to turn on notifications for.

By default, all values are selected.

4.3.2 Options Tab

The option tab allows you to remove notifications to Project and System channels.

By default, the option is deselected.

Click Save to create an Issue channel.

4.3.3 Message format Tab

You can choose a “Message Format” for all your Notifications (System, Project, and Issue Notifications).   Go to the channel settings, “Message format” tab. List of Message Format includes a list of all issue fields and statuses.

Each field or status has a checkbox beside it. If a field or status is checked, then it will be shown at the bottom of the notification displayed in Slack. Example of Notifications:.

1. If Comment, Time spent and Status are selected, a sample notification in Slack will look as follows:

2. If Priority, Reporter and Type are selected a sample notification in Slack will look as follows:

4.4 Sending Notifications to Existing Channel
 

While creating any type of Notification channel you can send notifications to the existing channel in Slack.

Example for issue notifications:

1. Open any Jira item and select "Create" in the Slack Integration section.

2. Click on the Existing channel drop-down list and select any Slack channel.  Fill in the channel topic and change Events and Options tabs if needed

4.5 Sending notifications to individuals

While creating any type of Notification channel you can select to send notifications only to individuals in Slack.

Example for the issue notifications:

 

1. Open any Jira item and select "create" in the Slack Integration section.

2. Click on the Direct channel drop-down list and select any Slack user. Fill in the channel topic and change Events and Options tabs if needed.

3. Click Save to create Issue notifications that will be sent only to the selected individual.

4.6 Sending notifications to private channels
 

You can send notifications to both public and private channels. Workflow is the same for the public channels, except for the Channel name field. Please include the recently created private Slack channel name in this field. For security reasons, you will not find existing private channels listed in the Existing Channel dropdown. You'll need to create a new private channel inside Slack and then add the name under the Channel name. 

This video shows how to create and connect a private channel at the Jira project level: 

This video shows how to create and connect a private channel at the Jira issue level: 

4.7 Using one channel for many notifications
 

You can send many notifications to one Slack channel. For example, all System, Project and Issue notifications can be sent directly to one selected channel (public or private).

If you would like to receive many notifications using one channel, include recently the created Slack channel name in the Channel name field while adding new notifications.

4.8 Turning off notifications on the issue page
 

You can turn off the Jira Slack Integration addon view on the issue page. You need to go to the issue tab and use the toggle button for turning it off. Issue configuration, notifications and any other screens inside issues are no longer be visible.

4.9 Threaded Notifications in Slack
 

You can create a notification in Slack Threaded message. When checked, all notifications will be shown in a Slack Threaded message. Each unique notification that is considered goes to its own thread. This feature should be selected in all notifications under options System, Project, Issue Notifications. By default, this option is off.

To go to this option, tap on “Start a thread” in your channel.

5. Slack Commands

The commands allow you to create, view and change Jira issue info via a Slack channel.

 
5.1 Setting Default Project

The command sets the default project that enable the work of Jira commands. You must have a project defined for issue related commands to work.  

Command Usage  /jira project <projectkey>

As response you receive the notification that the default project is set.

5.2 Create an issue

The command allows you to create an issue in Jira via the Slack channel.

Command Usage  /jira create :<parameter> [value]  ...

 
5.2.1 Parameters

:summary  (required)  specifies Jira issue summary

:issuetype (optional)  one of valid issue types.  task | bug | story  If no issue type is selected default to task.

:desc (optional) specifies Jira issue description.

:priority (optional) specifies Jira issue priority. Must be a valid priority or error message states priority is not defined in Jira.

:assignee (optional) specifies Jira issue assignee. Must be a valid assignee or error message states assignee is not defined in Jira.

:reporter (optional)  Default value is a current Slack user with appropriate Jira account. If reporter is selected, that must be a valid existing Jira account.

:project (optional)  default project used if not specified.

As a response, you receive a notification that the issue is successfully created.

5.3 Get an Issue

The command allows to get a short or detail information about an issue.

Command Usage  /jira get <issuekey> [detail]

Issuekey - Any valid issue i.e. JIR-23

Detail - not required parameter, returns detailed info about Issue

 

By default, you receive the following information: project, Issue #, summary, description, assignee.

If Detail is selected as an option, then you will receive the following issue info: project, Issue #, summary, description, assignee, reporter, components, and status

5.4 Transition as Issue

The command allows to change a status of an issue.

Command Usage /jira transition <issuekey>

Issuekey - Any valid issue i.e. JIR-23

 

After sending a command you receive Slack buttons with statuses (To Do / In Progress / Done) that are available for current issue now.

 

After clicking a proper button you receive a notification that the issue has been transitioned.

5.5 Search issues

The command allows to search for a single issue or multiple issues using JQL.

 

Command Usage /jira search <JQL>

 

After you receive a list of issues and summary that match the JQL

5.6 Assign an Issue

The command allows to assign an issue to another Jira user or to yourself.

Command Usage /jira assign <issuekey>

Issuekey - Any valid issue i.e. JIR-23

 

You will see a Slack menu showing a list of valid users to assign the issue to.  

 

After, you will receive Project, Issue and New Assignee

5.7 Help

The command returns a list of all valid commands and also the details about specific commands.

 

Command Usage

/jira ?

/jira help

 

To receive a detail help information about any valid command you can use the following command:

/jira <command>

For example,  /jira create

6. FAQ

Below is a list of frequently asked questions about the Slack Jira Integration: 

 
Is there a way to disable Jira update notifications in Slack channels? 

Yes. Jira notifications are configured at the issue (ticket) level, project, or for the entire system (instance) of your Jira. Many of our user's set up rules for each project based on specific types of Jira issues and specific events for those issues they want to be notified about inside Jira. The Filter tab allows you to select which types of Jira issues inside a project (or instance) you want to send notifications for. You can even use JQL to filter down to very specific types of issues. On the events tab, you can select which types of activities (events) on a Jira issue you want to send a notification for. So there's no need to have notifications for every issue and every event - you'll want to pick the things that really matter to your team. 

How do I find the System settings to control the Jira Slack Integration for my entire Jira instance? 

Below are screenshots that should take you to the System settings: 

Where do I find the advanced JQL Filter settings?

These are available at the System and Project level to have granular control over which Jira issues send notifications to Slack. For example, in the System settings menu you would find the JQL filter option here: 

When I enter a new Jira issue, can I have it send that issue information to a new issue specific channel? 

You can create notifications at the System or Project level to automatically send notifications to a specific Slack channel anytime new issues are created that meet the filter/event criteria you set. However, at this time you cannot automatically spawn a new Slack channel that's specific to that one new issue. You'll have to manually go into that Jira issue and use our app settings to connect to a new Slack channel.

 

We are adding this functionality and it will be available soon. 

We run our own instance of Jira on one of our own servers. Is this Jira Slack Integration compatible with our Jira server? 

Unfortunately, this integration is only available for Jira Cloud. We are considering building a Server version in the future. 

I only found your Cloud hosting option. Do you have or plan to have support for the Data Center version of Jira? 

It's on our roadmap, but not available at this time. 

Can I hide this integration inside Jira issues? We would like to limit our user's ability to create new Slack Channels. 

This is currently not available, but it's something currently under development. 

Can I connect a Jira issue to an existing Slack channel? 

Yes, when configuring the notifications type in the name of the Slack channel you would like the notifications sent to. You can also select private channels. Note, for private channels, you'll have to have connected the app with an admin account that has access to send messages to private channels. 

Event notifications (like creating an issue or a comment) are not being pushed to Slack. The rest of the app seems to be working, including creating channels and Slack commands. Why aren't notifications working? 

There are two possibilities: permissions or configuration. Check that you used a Slack admin user when connecting the app to Slack. If you didn't, try disconnecting the app and re-connecting as an admin. After that check your notification configuration. You need to select which issues you want to include/exclude from notifications and what events you want to cause notifications. You can do this inside a Jira issue, at the project level, or system level. It's possible you aren't including any issues to send notifications.

Every time a Slack channel is created it's showing that I personally created it and I am invited to the channel. Why? 

It's recommended you create a dedicated Slack admin user that's solely used for connecting this app from Jira to Slack. If you use a Slack admin account that's actively used by someone they'll end up receiving some system notifications inside their Slack which could be annoying to their daily workflow.

I set up the app, but I'm not getting any notifications in Slack. What should I do?
  1. Open the Slack Jira Integration apps

  2. If Slack is not connected, click the “Sign In” button and log in Slack

  3. Make sure that filters and events are configured correctly in the channels:

  4. Open the Slack Jira Integration apps

  5. Go to any channels

  6. Make sure filters, that you need, are enabled  

Make sure system and project channels are created:

  1. Open the Slack Jira Integration apps

  2. Go to system or project channel tab

  3. Make sure that system or project channel are created