Jira Software

Learn how to get started with Actioner's Jira app.

---

Install Jira Software from app directory and start using it by connecting your Jira and Slack.

Get started as a user

If you are invited to this app as a user, proceed to Get started as a user section to learn how to connect your Jira account.

Features

Visit this link to learn about Jira Software use cases.

• 🔔 Receive Jira alerts in Slack: Stay informed about new issues with smart notifications and monitor their progress in your preferred Slack channel.
• 🛠️ Take actions on your issues: Report issues with a simple emoji, and conveniently view, assign, update status, log work, and add your comments directly in Slack.
• 🤝 Dedicated channels for critical issues: Foster collaboration by creating dedicated channels for critical issues, and invite your team to join forces in resolving them.
• 🔎 Search and list your issues: Easily list your open issues and conduct searches using filters or JQL—all within Slack.
• 🎯 Planning poker sessions: Improve accuracy and consistency in estimating task complexity across your projects by participating in collaborative estimation sessions with your team in Slack.

How to get started

Step 1. Install Jira Software

Visit Jira Software in app directory and click Install button at top right corner.

Step 2. Connect to Jira and Slack

After installing the app, you'll be prompted to connect your Slack workspace and Jira account.

Complete Jira connection

1. Click Connect near Jira connection and proceed to authentication in Jira via OAuth2.
2. You will be asked to sign in to your Jira instance if you haven't already.
3. Click Connect app. You’ll be redirected to Actioner upon successful authorization.

Complete Slack connection

If you have not connected your Slack workspace, you can click Connect near Slack connection.

Slack connection

You can also add your Slack workspace by navigating to Workspace settings page from left menu and then switching to Slack workspace tab.

If you do not see Workspace settings page, contact with your workspace admin.

Step 3. Complete setup

Run Set up your Jira project and create webhooks in Jira by selecting your project. This workflow

• Creates webhook and issue-related triggers in your Jira account
• Creates a new channel in your Slack account (with #actioner- prefix) and starts to send notifications for issues in the selected project.
• Creates another channel in your Slack (#actioner-report-issue). When a ticket 🎫 emoji is added to a message in this channel, users are prompted to create a new issue in Jira. You can also check an issue's status by mentioning its key, such as "What is the status of DEMO-1?".

Step 4. Invite your team

By default Everyone in your Actioner workspace is added to your app as Runner.

To grant app admin permission to a user, go to the Permissions tab of your app and add users or groups via + Add permission button. If you can't find the users you want to add, ensure they have been invited to your Actioner workspace.

Get started as a user

If you are invited to this app as a user, you need to complete Jira connection. This connection is required for you to take actions on Jira notifications and to run workflows from Actioner shortcut in Slack.

1. Navigate to Jira connection, click Connect and proceed to authentication in Jira via OAuth2.
2. You will be asked to sign in to your Jira instance if you haven't already.
3. Click Connect app. You’ll be redirected to Actioner upon successful authorization.

How to use this app

Enable/disable notifications

During the setup of your solution for Jira Software, you’ll be prompted to complete some steps. These steps are necessary for your app to get up and running in Slack. After the setup, you can also update your notification settings.

For this, go to Config tab of your app and navigate to appConfiguration.

• siteUrl: Specifies the URL of the Jira site where your app for Slack is connected.
• createDedicatedChannelForCriticalIssues: Determines whether a dedicated channel should be created for issues with Highest priority or critical label. Set this property to true if you want to automatically create a new channel for critical issues.
• eventNotifications: Defines which types of notifications are sent to selected project channels. You can enable or disable notifications for the following events:
  • issueCreated: is triggered when an issue is created.
  • issueUpdated: is triggered when an issue is updated.
  • issueDeleted: is triggered when an issue is deleted.
  • commentAdded: is triggered when a new comment is added to an issue.
  • worklogAdded: is triggered when a worklog is created.
• dmNotificationPreferences: Controls the direct message (DM) notifications sent to your users in Slack. You can customize notifications for the following users:
  • notifyReporter: When set as true, the reporter of the issues gets a DM for enabled eventNotifications.
  • notifyAssignee: When set as true, the assignee of the issues gets a DM for enabled eventNotifications.
  • notifyWatcher: When set as true, the watchers of the issues gets a DM for enabled eventNotifications.
  • notifyMentions: When set as true, the mentioned user in Jira gets a DM in Slack.
• planningPokerEstimationField: Shows the key of the Jira field that will be updated once final estimation is set for an issue during planning poker. If you want to map Original estimate field in Jira, set this parameter as originaltimeestimate. If you want to another custom field, enter the ID of that field, such as customfield_10016.
• isLogWorkReminderEnabled: When set as true, it reminds you to log work for open and in progress issues.

Set up your project and issue reporting channels

Project channels

Project channels are the dedicated Slack channels for your selected Jira project. New issues and their updates can be tracked through notifications sent by Actioner. Moreover, your team can manage the issues through these notifications.

You can run Configure channels for Jira notifications in Slack or in Actioner to select your channel that you want to get notified for issues in the selected Jira project.

Issue reporting channels

Issue reporting channels are the dedicated Slack channels for your Slack users to report issues by adding ticket 🎫 emoji to their Slack messages. These channel streamline the issue creation process and lets your team create issues without leaving Slack.

You can run Configure channels to report a Jira issue in Slack or in Actioner to select your channel for reporting new Jira issues.

Invite Actioner to your channels

Do not forget to invite Actioner to your project and issue reporting channels!

---

Alternative way to set your project and issue reporting channels is through Config.

1. Go to Configs tab of your app and navigate to channelConfiguration.

2. Add your new channels in the below format:

{
  "projectChannels": [
    {
      "projectId": "10004",
      "channelId": "C01234ABCDE",
      "emojiToAssignIssue": "eyes",
      "emojiToResolveIssue": "white_check_mark",
      "emojiToAddComment": "pushpin",
      "getIssueUpdates": true,
      "threadSync": false
    }
  ],
  "reportIssueChannels": [
    {
      "channelId": "C09876ABCDE",
      "emojiToCreateIssue": "ticket",
      "emojiToAssignIssue": "eyes",
      "emojiToResolveIssue": "white_check_mark",
      "emojiToAddComment": "pushpin",
      "getIssueUpdates": true,
      "threadSync": false
    }
  ]
}

Properties for projectChannels

• projectId: The ID of your Jira project.
• channelId: The ID of your Slack channel where you'll get notifications for issues in the selected Slack project.
• channelName: The name of the Slack channel.
• emojiToAssignIssue: The emoji used to assign the issue to the user who adds this emoji. By default, it is set as "eyes".
• emojiToResolveIssue: The emoji used to mark an issue as resolved. By default, it is set as "white_check_mark".
• emojiToAddComment: The emoji used to add your Slack message as a new comment to your Jira issue. By default, it is set as "pushpin".
• getIssueUpdates: Set this parameter to true to show the updates in the thread of corresponding issue's notification.
• threadSync: Set this parameter to true to convert Slack messages into issue comments. When enabled, any messages posted to the thread of an issue's notification will be created as a new comment in the corresponding issue in Jira.

Properties for reportIssueChannels

• channelId: The ID of your Slack channel dedicated for reporting issues.
• emojiToCreateIssue: The emoji used to report a new issue. By default, it is set as "ticket".
• emojiToAssignIssue: The emoji used to assign the issue to the user who adds this emoji. By default, it is set as "eyes".
• emojiToResolveIssue: The emoji used to mark an issue as resolved. By default, it is set as "white_check_mark".
• emojiToAddComment: The emoji used to add your Slack message as a new comment to your Jira issue. By default, it is set as "pushpin".
• getIssueUpdates: Set this parameter to true to show the updates in the thread of corresponding issue's notification.
• threadSync: Set this parameter to true to convert Slack messages into issue comments. When enabled, any messages posted to the thread of an issue's notification will be created as a new comment in the corresponding issue in Jira.

Enable/disable personal notifications

By default, you get DM notifications if you're the reporter, assignee or a watcher of an issue and if you are mentioned in Jira. To update your personal notification preferences, you can run Configure personal notifications in Slack or in Actioner. You can enable or disable below options:

• Notify me when I am the reporter
• Notify me when I am the assignee for an issue
• Notify me when I am watcher of an issue
• Notify me when I am mentioned

Planning poker sessions

Actioner lets you host sprint planning poker sessions directly in Slack. You can add your Jira issues to a planning poker game and start the session by following below steps:

1. Visit planning poker in app directory and click Install button at top right corner.

2. Go to Configs tab of your Jira Software app and then navigate to appConfiguration.

   

3. On planningPokerEstimationField, enter the key of the Jira field that will be updated once the final estimation is set for an issue.

   If you want to map Original estimate field in Jira, you may enter originaltimeestimate. If you want to use your custom field, enter the ID of that field, such as customfield_10016.

   

4. To start a session in Slack, call /actioner command and select the workflow named Create Planning poker game.

   

5. Once the game starts, you can start adding your Jira issues. You have two options:

• ➕ Add issues: This option lets you select the Jira issues that will be added to your planning session.

• ➕ Add issues with JQL: This option lets you add the Jira issues to your planning session that match with your JQL.

  

Troubleshooting

"Only a single URL per app is allowed to be registered via REST API" error during the setup

While running Configure channels for Jira notifications during the setup, you might get "Only a single URL per app is allowed to be registered via REST API" error.

This error occurs because Jira API does not allow registering webhooks to different endpoints in the scope of a single Jira instance. You'd come across this one if you installed Jira Software app from Actioner app directory before and completed its setup.

To solve it, you can run Delete webhooks workflow in your Jira app. This will remove the previously created webhook for Actioner to capture events in your Jira instance.

For this, first close the setup and go to Workflows tab and find the Delete webhooks workflow. Run it from play button at top right corner. After deleting the previous webhooks, you can proceed to setup where you left off.

Please note that if you've another Jira Software app working on your Slack (that is installed from Actioner's app directory), Delete webhooks workflow will disconnect it. If you want to get the Jira Software app working in 2 different Slack workspaces, you can ask another Jira admin in your instance to complete the setup for the newly installed app.