Rate this page:
Welcome to the Jira Cloud platform developer documentation! Jira Cloud platform provides a set of base functionality shared across all Jira products, such as issues, workflows, and more. Jira products are built on top of the Jira Cloud platform. Jira Core has the same functionality as the Jira Cloud platform, whereas Jira Software and Jira Service Management have additional functionality.
Developers can customize, extend, and integrate with Jira by creating apps. Apps can integrate Jira with an existing service, add new features to Jira, update Jira settings, or retrieve information from Jira.
This page covers the basics of developing for Jira Cloud:
We recommend using Forge or Connect to build apps. You can also integrate with Jira Cloud by building OAuth 2.0 (3LO) apps or calling the REST APIs via scripts or other API clients.
Forge is Atlassian's new development platform for building Jira and Confluence Cloud apps. We recommend Forge if you plan on building apps for use within your organization. Forge is also recommended for developers building their first Atlassian cloud app, or any developers who want less infrastructure and hosting overhead. Note that Marketplace distribution is not yet available for Forge apps.
Atlassian Connect is a framework for building apps for Jira, Confluence, and Bitbucket Cloud. We recommend Connect for developers who need to sell their cloud app or integration in the Atlassian Marketplace now or in the near future. Connect is also a good option for developers who want complete control over the tech stack and infrastructure, for example, projects that require more control over storage or compute hosting.
To start building a Connect app, see Getting started with Connect.
Note that there are a number of frameworks for Connect that make it easier to create apps. See Connect frameworks and tools for details.
Apps built without Forge or Connect can still access data and create content through the Jira APIs. These apps can use OAuth 2.0 (3LO) or basic auth to pass information between your app and Jira, depending on your security needs. See the Security section below for more details.
Note that Forge and Connect are required to implement certain functionality in apps. For example, only Forge and Connect apps can extend the user interface of products.
You can use the Jira Cloud platform APIs in Jira apps, as well as in scripts, API clients, or other methods of making calls.
Follow our design guidelines to make your app consistent with Atlassian's products. We also have resources to help keep your Jira app secure and add it to the Atlassian Marketplace.
Since Forge and Connect apps can insert content directly into the user interface, it's important that apps are visually compatible with Atlassian design. We have resources to help you design your app:
There are a few basic options for security, depending on what sort of app you are trying to make:
Read the Security overview for more details.
You can sell your app on the Atlassian Marketplace so other cloud users can install it, or list it privately if you don't intend to sell or distribute your code. Private listings use secret tokens that you can generate yourself.
Check out our example apps and patterns for app ideas and strategies, or see some tutorials on more advanced topics:
Rate this page: