Bamboo Tasks API

Providing an icon for your Bamboo Task

In Bamboo 3.4 and above, it is possible to give your Task plugin an easily identifiable icon when a user browses for Tasks.

Defining your icon

  1. In your atlassian-plugin.xml add the following line between the taskType elements:

    <resource type="download" name="icon" location="icon.png"/>
  2. Add your icon.png to the src/main/resources directory of your project


  • For best results your icon's dimensions should be exactly 80 by 80 pixels. If it is larger or smaller than the required sized it may be scaled
  • For the icon to be displayed, the user must have Bamboo 3.4 or above installed. For developers writing Tasks that target Bamboo 3.1 and above, defining an icon will not cause versions Bamboo 3.3 and below to break.
  • Atlassian recommends that icons should be transparent and not filled white. Transparent backgrounds will allow your icon to be displayed on other parts of the user interface in a way that is aesthetically pleasing.

Rate this page: