Gpt Action Jira
GPT Action Library: Jira
Introduction
This page provides an instruction & guide for developers building a GPT Action for a specific application. Before you proceed, make sure to first familiarize yourself with the following information:
This particular GPT Action provides an overview of how to connect to Jira, Atlassian's tool for project and ticket management. This action assumes a user’s context and allows them to read and write to issues in a given project.
Value + Example Business Use Cases
Value: Users can now leverage ChatGPT's natural language capability to connect directly to Jira Cloud
Example Use Cases:
- A user can load up recent issues for a particular project and use ChatGPT to provide solutions
- A user can create and alter issues and sub-tasks and assign to specific users by instructing ChatGPT
Application Information
Application Key Links
Check out these links from the application before you get started:
- Application Website: https://<YOUR_SUBDOMAIN>.atlassian.net/jira
- Application API Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
- Application OAuth 2.0 Documentation: https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/
Application Prerequisites
Before you get started, make sure you go through the following steps in your application environment:
- Ensure you have the access and permissions to create an application in the Atlassian Cloud Developer Console
ChatGPT Steps
Custom GPT Instructions
Once you've created a Custom GPT, copy the text below in the Instructions panel. Have questions? Check out Getting Started Example to see how this step works in more detail.
OpenAPI Schema
Once you've created a Custom GPT, copy the text below in the Actions panel. Have questions? Check out Getting Started Example to see how this step works in more detail.
NOTE: Replace the placeholder <CLOUD_ID> in url with your cloud environment's unique ID. You can find this value by visiting https://<YOUR_SUBDOMAIN>.atlassian.net/_edge/tenant_info
Authentication Instructions
Below are instructions on setting up authentication with Jira. Have questions? Check out Getting Started Example to see how this step works in more detail.
Jira Steps
- Create an Application: The first step is to create a new application in Jira for the integration with ChatGPT. This can be done by visiting the Atlassian Developer Console, Clicking Create and selecting OAuth 2.0 Integration.
From here, simply enter the name of your integration and click Create.
- Define Permissions: Next we need to provide the required permissions to our application. Within the new application, open the Permissions menu from the sidebar, locate Jira API and click Add and then Configure.
Required permissions will vary depending on the intended functionality of the GPT. In this scenario we wish to read and write to Jira issues, so select the following scopes under Jira platform REST API by clicking Edit Scopes:
- read:jira-work
- write:jira-work
- read:jira-user
Once selected, click Save
- Configure Placeholder Callback URL: In order to complete the following step and obtain a Client ID and Secret for enabling secure authentication between ChatGPT and Jira, we first need to add a placeholder callback URL. We can achieve this by clicking on Authorization in the sidebar, and Configure next to OAuth 2.0 (3LO). From here simply enter a placeholder URL and click Save Changes.
-
Application Client ID/Secret: The next step is to locate the Client ID and Secret for enabling secure authentication between ChatGPT and Jira. We can find these values by clicking on Settings in the sidebar and scrolling down to Authentication Details.
Keep this page open as we will require these values in the next stage of configuration!
In ChatGPT
In ChatGPT, click on "Authentication" and choose "OAuth". Enter in the information below.
- Client ID: The Client ID from Step 3 of Jira Configuration
- Client Secret: The Secret from Step 3 of Jira Configuration
- Authorization URL: https://auth.atlassian.com/authorize
- Token URL: https://auth.atlassian.com/oauth/token
- Scope: read:jira-work write:jira-work read:jira-user
- Token Exchange Method: Default (POST Request)
Post-Action Steps
Once you've set up authentication in ChatGPT, follow the steps below in the application to finalize the Action.
- Copy the callback URL from the GPT Action
- In your application in the Atlassian Developer Console, navigate to the Authorization sidebar tab, next to OAuth 2.0 (3L0) click Configure, and add your callback URL under Callback URL
FAQ & Troubleshooting
- Callback URL Error: If you get a callback URL error in ChatGPT, double check the Callback URL value as it can occasionally change depending on any alterations made to the authentication
Are there integrations that you’d like us to prioritize? Are there errors in our integrations? File a PR or issue in our github, and we’ll take a look.