You're on your way to the next level! Join the Kudos program to earn points and save your progress.
Level 1: Seed
25 / 150 points
1 badge earned
Challenges come and go, but your rewards stay with you. Do more to earn more!
What goes around comes around! Share the love by gifting kudos to your peers.
Keep earning points to reach the top of the leaderboard. It resets every quarter so you always have a chance!
Join now to unlock these features and more
The Atlassian Community can help you and your team get more value out of Atlassian products and practices.
Back in 2014, I made a presentation at Atlassian Summit that I hoped would challenge people's assumptions that Confluence Cloud was limited and inflexible as a solution. In it, I talk about core Confluence features (templates, macros, permissions, and space architecture) and also the possibilities of Atlassian Connect.
Some details and features have changed since then, but for the most part, the concepts in the presentation are still valid. In particular, you can still use the Atlassian Connect framework to make simple custom macros, and you don't need to be a professional programmer either.
I thought it might be worthwhile re-sharing this again.
But I'm not a developer or programmer, how could I use Atlassian Connect?
For a simple, static content macro that doesn't have any logic or configuration required (i.e. reusable blocks of content) you only need these three things:
Those 3 files are uploaded to your hosting then installed into your Confluence Cloud instance.
The file that contains your content will be a snippet of HTML / Storage Format text. An easy way to create your content snippet is to draft it on a Confluence page, then use the view storage format tool. E.g. this content
looks like this in Confluence's storage format:
<p>Hello, world!</p><ac:structured-macro ac:name="info" ac:schema-version="1" ac:macro-id="b1298625-64bf-42e8-b3bc-e3489526e9bc"><ac:rich-text-body>
<p>This is an info panel</p></ac:rich-text-body></ac:structured-macro>
An atlassian-connect.json template
You don't need to really know much about the atlassian-connect.json file, although there are lots of different configuration options if you want to learn more about it.
Here is a template you can use – I have added comments where you need to make changes to this base configuration. Once you have made you changes, you can check that your atlassian-connect.json is right using this online validation tool created by Atlassian, which is hosted at https://atlassian-connect-validator.herokuapp.com/validate
If you want to make this a block rather than inline macro, change the outputType parameter to "block".
"key": "A unique key for your – e.g. com-yourdomain-anameforyourmacro",
"name": "A human friendly name for your of macro",
"description": "Describe your macro – e.g. Demo add-on for the Atlassian Summit 2014.",
"baseUrl": "This is the URL where you macro code is hosted - e.g. https://mymacros3domain.s3.amazonaws.com/",
"name": "Your organisation’s name",
"url": "Your organisation’s URL e.g. http://yourdomain.com"
"key": "A unique key for your macro – e.g. static-macro-homepage",
"value": "The name of your macro"
How do I install and test my macro?
Initially, you can install directly by using development mode in Confluence Cloud.
However, you can then deploy as a private app via the marketplace.
You can also request a free development instance of Confluence Cloud, so you can test separately before making it available to your users.
Chief Technology Solutions
85 accepted answers