Extending JIRA applications

JIRA is very flexible, and has a number of extension points where JIRA's data can be queried or its functionality extended. This page provides an overview of the mechanisms available for extending JIRA.

(info) JIRA add-ons: For information on installing or enabling existing add-ons, please read the Managing add-ons documentation. To learn about creating your own add-ons, see developing add-ons with the Atlassian Plugin SDK.

Note that an add-on that specifically plugs into the architecture of an Atlassian application such as JIRA is sometimes called a plugin, although the terms 'plugin' and 'add-on' are often used interchangeably.

Custom field types

JIRA comes with various custom field types defined. New types can be written and plugged into JIRA. See the How to create a new Custom Field Type tutorial for more information.

User formats

JIRA comes with many options to change the look and feel of features in the system. User formats are a feature that can be customized by add-ons. You can write your own user format add-on to change the display of user details in JIRA, e.g. display a profile picture. See the User Format Plugin Module for more information.


New gadgets can be created by writing an XML descriptor file, packaged as an Atlassian plugin. See Tutorial - Writing gadgets for JIRA for more information.


JIRA comes with various reports built-in. Using the plugin system, new reports can be written, providing new ways of viewing and summarizing JIRA's data.

Workflow functions and conditions

JIRA's issue workflow (states and state transitions an issue can go through) can be customized through the web interface (see the workflow documentation. The workflow engine provides hooks where you can plug in your own behavior:

  • Run arbitrary Java when a certain transition occurs, via post-functions.
  • Limit visibility of transitions to certain users, via conditions.
  • Validate input on transition screens (eg. in comments), via validators.

See the Working with workflows for details on workflow post-functions, conditions, and validators. Once written, these can be packaged as plugins and reused.

Issues and projects

On the 'View Issue' page, some issue information (comments, change history) is displayed. Likewise, the 'Browse Project' page contains separate sections, listed on the far left, for different types of project information.

By writing a plugin, you can add new issue or project sections (that will be listed in the left panel) to JIRA. For instance, you may wish to display project/issue data pulled in from an external source. This is how the JIRA Subversion plugin works.

Listeners (Note this is not configurable in JIRA Cloud applications)

JIRA has a complete event subsystem, which fires events whenever anything happens. For example, an ISSUE_CREATED event is fired whenever an issue is created. A listener is just a class that implements a JiraListener interface, and is called whenever events occur in JIRA. Using those events, you can then perform any action you want. For example the email sent by JIRA is driven by the MailListener. This is useful when you want to drive or affect external systems from events, which occur within JIRA — usually used to push data into outside systems.For more information, read the listeners documentation.


Services are classes that implement the JiraService interface.When installed, you specify an update period, and JIRA will call the run() method of your service periodically. A sample service is POPCommentService. This service checks a particular POP mailbox periodically, and if it finds messages, tries to extract an issue key from the subject. If the subject contains a key, the body of the mail is added as a comment to the message. Services are useful when you want to periodically pull data into JIRA from outside systems. For more information, see the services guide.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport