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.
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.
The following information describes how to use IBM App Connect to connect Jira to your other applications.
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 on the Private networks page. For more information, see Connecting to a private network.
To connect to a Jira endpoint from the App Connect Designer Applications and APIs 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 Applications and APIs 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.
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 Applications and APIs page of the App Connect Designer.
For some applications, the events and actions 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.
Jira actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Filters | Create filter | Creates a filter |
| Delete filter | Deletes a filter | |
| Retrieve filters | Retrieves a filter | |
| Update filter | Updates a filter | |
| Groups | Create group | Creates a group |
| Delete group | Deletes a group | |
| Retrieve groups | Retrieves groups | |
| Issue attachments | Create issue attachment | Creates an issue attachment |
| Delete issue attachment | Deletes an issue attachment | |
| Download attachment content | Downloads the attachment content | |
| Retrieve issue attachments | Retrieves an issue attachment | |
| Issue comments | Create issue comment | Creates an issue comment |
| Delete issue comment | Deletes an issue comment | |
| Retrieve issue comments | Retrieves issue comments | |
| Update issue comment | Updates an issue comment | |
| Issue link types | Create issue link type | Creates an issue link type |
| Delete issue link type | Deletes an issue link type | |
| Retrieve issue link types | Retrieves an issue linkt ype | |
| Update issue link type | Updates an issue link type | |
| Issue links | Delete issue link | Deletes an issue link |
| Retrieve issue links | Retrieves an issue link | |
| Issue types | Create issue type | Creates an issue type |
| Delete issue type | Deletes an issue type | |
| Retrieve issue types | Retrieves an issue type | |
| Update issue type | Updates an issue type | |
| Issue votes | Add vote to issue | Adds a vote to an issue |
| Remove vote from issue | Removes a vote from an issue | |
| Retrieve issue votes | Retrieves vote details for an issue | |
| Issue watchers | Add me as watcher to issue | Adds myself as a watcher the issue |
| Remove from issue watcher list | Removes from the issue watcher list | |
| Retrieve issue watchers | Retrieves issue watchers | |
| Issue worklogs | Create issue worklog | Creates an issue worklog |
| Delete issue worklog | Deletes an issue worklog | |
| Retrieve issue worklogs | Retrieves an issue worklog | |
| Update issue worklog | Updates an issue worklog | |
| Issues | Add subtask to an issue | Adds a subtask to a Jira issue |
| Create issue | Creates an issue in Jira | |
| Delete issue | Deletes an issue from Jira | |
| Retrieve all issues | Retrieves all issues | |
| Retrieve issue | Retrieves issues from Jira | |
| Update issue | Updates an issue in Jira | |
| Notification schemes | Retrieve notification schemes | Retrieves a notification scheme |
| Permissions | Retrieve my permissions | Lists all my permission in the Jira instance |
| Retrieve permissions | Retrieves permissions | |
| Priorities | Retrieve priorities | Retrieves priorities |
| Project components | Create project component | Creates a project component |
| Delete project component | Deletes a project component | |
| Retrieve project components | Retrieves a project component | |
| Update project component | Updates a project component | |
| Project roles | Create project role | Creates a project role |
| Delete project role | Deletes a project role | |
| Retrieve project roles | Retrieves a project role | |
| Update project role | Updates a project role | |
| Project types | Retrieve project types | Retrieves project types |
| Project versions | Create project version | Creates a project versionn |
| Delete project version | Deletes a project version | |
| Retrieve project versions | Retrieves a project version | |
| Update project version | Updates a project version | |
| Projects | Create project | Creates a project |
| Delete project | Deletes a project | |
| Retrieve projects | Retrieves a project | |
| Update project | Updates a project | |
| Resolutions | Retrieve resolutions | Retrieves a resolution |
| Statuses | Retrieve statuses | Retrieves statuses |
| Users | Find users with permissions | Retrieves a list of users based on the specified permissions |
| Retrieve users | Retrieves users | |
| Retrieve users assignable for issue | Retrieves users assignable for an issue | |
| Retrieve users assignable for project | Retrieves users assignable for a 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, go to the Discover page and search for Jira.
