Rate this page:
Welcome to the Confluence Cloud developer documentation! Confluence is a knowledge sharing tool that helps teams create and share content.
Developers can customize, extend, and integrate with Confluence by creating apps. Apps can integrate Confluence with an existing service, add new features to Confluence, create and manage content, or create new workflows and collaboration tools for Confluence users.
This page covers the basics of developing for Confluence Cloud:
We recommend using Atlassian Connect to build apps, but you can also integrate in other ways. For example, you can develop apps without Connect, or call the REST APIs via scripts or other API clients.
Atlassian Connect provides tools that simplify building apps for Atlassian products, including Confluence Cloud. Connect apps are web applications that operate remotely over HTTP. To end users, a Connect app looks like a fully integrated part of Confluence.
A Connect app can add elements to the Confluence UI, access APIs, and respond to events using webhooks. For example, a Connect app could pull data on pageviews from Confluence, then surface the number of views in a UI module at the top of every page.
You can build Connect apps in any language or framework, but Atlassian supports two toolkits to help you start building apps: Atlassian Connect Express (ACE) for Node.js and Atlassian Connect Spring Boot for Java. For information on other framework options, see Frameworks and tools.
Apps built without Atlassian Connect can still access data and create content through the Confluence APIs. Note that Connect provides some UI modules and elements that aren't available outside of Connect apps.
For security in external apps, you can use OAuth 2.0 (3LO) or OAuth 1.0 (basic auth) to pass information between your app and Confluence, depending on your security needs. See Security overview for more.
You can use the Confluence APIs in apps you develop for Confluence, 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 Confluence app secure and add it to the Atlassian Marketplace.
Since Connect apps can insert content directly into Confluence Cloud, it's important that apps are visually compatible with Atlassian design. We have resources to help you design your app:
There are three 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, like using webhooks or macros to integrate your service into Confluence.
Rate this page: