This documentation relates to an earlier version of Atlassian Gadgets.

Unknown macro: {spacejump}

or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

This page tells you how to add your gadget to an Atlassian application (JIRA, Confluence, etc) as a plugin. In short, you will add a <gadget> module type to your atlassian-plugin.xml file.

On this page:


This list of prerequisites is incomplete

TO DO: We need to add instructions for configuring specific Atlassian applications to support AGSL-1.

Purpose of the Gadget Module Type

Gadget plugin modules enable you to add your gadget to an Atlassian application (JIRA, Confluence, etc) as a plugin. Your gadget can then make use of the application's remote API to fetch data and interact with the application.


The element for the Gadget plugin module is gadget. It allows the following attributes for configuration:








The key attribute is a standard module key, so it is required and must be unique within the plugin across all module types. Atlassian Gadgets does not use this key for anything special, so you can choose any key you like.




The location attribute can be either the relative path to a resource within the plugin, or the absolute URL of an externally-hosted gadget.



The syntax of the module type is:

<atlassian-plugin name="Hello World" key="example.plugin.helloworld" plugins-version="2">
    <description>A basic gadget module</description>
    <vendor name="Atlassian Software Systems" url=""/>

  <gadget key="unique-gadget-key" location="path/to/gadget.xml"/>


URL for Published Gadgets

Gadgets published by an Atlassian container (such as JIRA or Confluence) are provided by the REST plugin module built into the Atlassian Gadgets framework. The URL of published gadgets has the following format — with context:

Or without context:


Creating your Gadget XML Specification
Writing an Atlassian Gadget
Gadgets and Dashboards Development Hub

  • No labels