How to use IBM App Connect with Jira
The Jira family of products includes Jira Software for release tracking, Jira Service Desk for customer support, and Jira Core for project management.
- App Connect Enterprise as a Service connector
Local
connector in containers (Continuous Delivery release)-
Local connector in containers (Long Term Support release)
-
Local connector in containers (Long Term Support Cycle-2 release)
You can use IBM® App Connect to integrate applications with both Jira Cloud and Jira Server. You can integrate with all the project templates that are available in Jira, including custom templates. IBM App Connect supports all objects (including custom objects) that are defined in a Jira project, and all create, retrieve, update, and delete operations.
Supported product and API versions
To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.
Connecting to Jira
- Jira host and port
- Enter the domain-specific Jira service URL that you use to
log in to the portal.
- For Jira Cloud, if your domain is xxx, the service URL is https://xxx.atlassian.net
- For Jira Server, the service URL is in the format https://myjirahost:port
- Username
-
- For Jira Cloud, enter the email address that you use to log in to your Atlassian account.
- For Jira Server, enter the username that you use to log in to Jira.
- Password (Jira Server) or API token (Jira Cloud)
-
- For Jira Cloud, enter the API token that you generate from your Atlassian account. For more information, see API tokens on the Atlassian website.
- For Jira Server, enter the password that you use to log in to Jira.
- Private network connection
-
Select the name of a private network agent that App Connect uses to connect to your private network. This list is populated with the names of private network agents that are created from the
Private network connections
tab of the Settings page. For more information, see Connecting to a private network.
To connect to a Jira endpoint from the App Connect Designer Catalog page for the first time, expand Jira, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.
After you create a Jira connection account, you can see the available events to trigger a flow by clicking Show configurable events under the account on the Applications tab.
(Click image to view full size.)
General considerations
Before you use App Connect Designer with Jira, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Catalog page of the App Connect Designer.
For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Jira events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.
Jira actions
Your flow completes these actions on this application.
- Permissions
-
- Retrieve permissions
- Retrieve my permissions
- Filters
-
- Create filter
- Retrieve filters
- Update filter
- Delete filter
- Groups
-
- Create group
- Retrieve all groups
- Retrieve groups
- Delete group
- Issue attachments
-
- Create issue attachment
- Retrieve issue attachments
- Delete issue attachment
- Download attachment content
- Issue comments
-
- Create issue comment
- Retrieve all issue comments
- Retrieve issue comments
- Update issue comment
- Delete issue comment
- Issue link types
-
- Retrieve issue link types
- Delete issue link type
- Update issue link type
- Create issue link type
- Issue links
-
- Retrieve issue links
- Delete issue link
- Issue types
-
- Create issue type
- Retrieve issue types
- Update issue type
- Delete issue type
- Issue watchers
-
- Retrieve issue watchers
- Add me as watcher to issue
- Remove from issue watcher list
- Issue worklogs
-
- Create issue worklog
- Retrieve issue worklogs
- Update issue worklog
- Delete issue worklog
- Issues
-
- Create issue
- Retrieve all issues
- Retrieve issue
- Update issue
- Delete issue
- Add subtask to an issue
- Notification schemes
-
- Retrieve notification schemes
- Priorities
-
- Retrieve priorities
- Project components
-
- Retrieve project components
- Delete project component
- Create project component
- Update project component
- Project roles
-
- Retrieve project roles
- Delete project role
- Update project role
- Create project role
- Project types
-
- Retrieve project types
- Project versions
-
- Retrieve project versions
- Delete project version
- Update project version
- Create project version
- Projects
-
- Create project
- Retrieve projects
- Update project
- Delete project
- Resolutions
-
- Retrieve resolutions
- Statuses
-
- Retrieve statuses
- Users
-
- Retrieve users
- Retrieve users assignable for issue
- Retrieve users assignable for project
Examples
Use templates to quickly create flows for Jira
Learn how to use App Connect templates to quickly create flows that complete actions on Jira. For example, open the Templates gallery, and then search for Jira.
