Documentation

Listing your add-on

Learn how to submit your add-on for approval. Once it's approved we'll list it in both the Atlassian Marketplace and the add-on directory inside Bitbucket Cloud.

Create an Atlassian account

To submit an add-on you'll need an Atlassian account and a Marketplace vendor identity. If you've already got both of those, skip to the next section. You're all set!

To set up an Atlassian account and a Marketplace vendor identity do the following:

  1. Go to Atlassian Marketplace.
  2. Log in using your Atlassian account credentials or click Sign up and create an account. Once you create an account you'll be redirected to the Atlassian Marketplace.
  3. Go to Create vendor. Complete and submit the form.

Create your listing

All add-ons are submitted as private add-ons. When you're ready you can submit your add-on for approval, we'll review it, and make it public when it's ready. You'll need details from your descriptor like your key, name, and baseUrl to complete the submission.

To submit your add-on for approval do the following:

  1. Sign into Marketplace with your Atlassian account credentials.
  2. Select your profile avatar > Create an add-on.
  3. Select Provide a URL to your artifact (.jar, .obr, .jwb or JSON descriptor)
  4. Click *Enter URL and add the URL of your add-on's descriptor.
  5. Add the Name for your add-on. Your name should follow Atlassian branding guidelines and your plugin key should be a unique representation of your add-on’s brand.
  6. Choose one of the following options:
  7. Save as Private: This places your entry into a holding state. We don't review your add-on until you move it to a Public state.
  8. Next: Make Public: We will review and list your add-on on the Bitbucket Integrations and add-ons page.

After you complete your submission, and make it public, our team will review the add-on and let you know when it will be made available to the public. This process generally takes about 5 business days.

Add-on directory

Bitbucket has an add-on directory that lists add-ons produced both by Atlassian and ecosystem developers. It is accessible via the drop down menu linked to your avatar, and via the Find new add-ons link on the Settings page.

add-ons directory

You can limit the add-on directory to just your add-on by appending your add-on key as the query parameter addon. For example:

https://bitbucket.org/account/addon-directory?addon=bitbucket-npm

will limit the directory to showing only the npm for Bitbucket add-on. This is useful if you want to send a filtered view of the add-on directory to a user wanting to install your add-on.