Can i add labels with the Javascript API for blueprint wizards?


is it possible to add labels by the Javascript API for blueprint wizards? Exists a variable for the label identifier?

E.g. in the $container or wizard data properties, like this to edit the page title:

state.pageData.title = titleString;

Link to the Atlassian Docs:

Thank you



4 answers

1 accepted

6 votes
Answer accepted

The above answer by Ruth can be made even more easy by changing the title and name attribute to name="labelsString" title="labelsString", this will enable a REST call within confluence to add the labels programatically like magic! No need to write any java code if you do this small change - give it a try.

Yagnesh Bhat, thanks, good tip! I removed the LabelManager code, and with name="labelsString" it works indeed. Ironically, I refactored the labelsString variable name for readbility, and that broke it. "title" seems to be another variable that we should not refactor.

But title="labelsString" is not needed, it only sets the tooltip in the wizard.

Atlassians, is this documented somewhere? My team keeps bumping into easy solutions like this by chance (for macros, for plugins, ...), after we spent a week trying to reinvent the wheel.

Yagnesh Bhat, thank you for your pointer. All I had to do was to add the following line in my dialog-wizard.js file: state.wizardData.labelsString = "new_label_to_add";


The complete (simplified) function looks like this:

Confluence.Blueprint.setWizard('a.b.c.plugins.confluence.knowledgebase.knowledgebase:create-kb-article-blueprint', function(wizard) {
    wizard.on('submit.page1Id', function(e, state) {
        state.wizardData.labelsString = "new_label_to_add";

Try the following for a LabelPicker.

In atlassian-plugin.xml add:


In your soy file, add:

<div class="field-group">
  <input id="my_article-labels" class="text select2-input long-field" 
      name="articleLabels" title="Search labels" type="text"

In your dialog-wizard.js add:

function postRender(e, state) {
  var wizardForm = state.$container;
  var labelsField = $("#my_article-labels", wizardForm);
      separator: " ",
      queryOpts: {
          spaceKey: state.wizardData.spaceKey

In BlueprintCreatedListener(LabelManager labelManager...)'s onPageCreateEvent() method, add:

Set<String> labelsList = new HashSet<String>();
labelsList.addAll(Arrays.asList((((String) context.get("articleLabels"))).split(",")));
for (String label : labelsList) {
    Label labelToAdd = new Label(label);
    labelManager.addLabel((Labelable) blueprintPage, labelToAdd);

The name="articleLabels" is your context variable that stores the labels.
The id="my_article-labels" is what connects the SOY input field to the JavaScript ui-component.

I'm also looking for a solution to do this within my custom blueprint (as Atlassian have done with their Troubleshooting Article blueprint). Can I aks did you find a solution - is there any snippets you can share?

Need this too any suggestions

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Thursday in Summit

Find a your Summit 2019 Buddy!

Can you believe there's less than one month until Summit 2019? It's time to start planning your agendas, not to mention packing ... In the meantime, introduce yourselves on this thread so that you ...

240 views 16 6
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you