Atlassian

Atlassian is a platform that provides tools for software developers and project managers to facilitate collaboration, software development, and project management.

Atlassian’s most popular products consist of:

  • Jira (project management)

  • Bitbucket (code collaboration and version control)

  • Trello (visual collaboration tool)

  • Confluence (documentation collaboration tool)

If you use Atlassian in your daily work, you likely have a Confluence wiki filled with valuable documentation. This documentation can be utilized by an agent within our platform. To enable this, you need to establish Atlassian credentials, which will grant access to your Atlassian tenant using the provided credentials of your Atlassian account.

These credentials can then be used to access the content of your Confluence wiki via an Atlassian Confluence data source.

Adding Atlassian credentials

Before creating Atlassian credentials, you must first ensure you possess an Atlassian tenant (e.g. mytenant.atlassian.net) and an account with an API key to be able to access the content from your Atlassian tenant (such as Confluence, Jira, etc.).

Generating the Atlassian API key

The API key (or API token) is used as a password in the Atlassian credentials configuration.

To generate the API key:

  1. Log in to your Atlassian tenant under a user account.

We strongly advise using an Atlassian Service Account with administrator permissions to generate the API token. This account needs to be tied to a license.

  1. Click Your profile and settings (the user avatar icon) in the top right of the window and select Manage Account.

image-20241014-125030.png
  1. Select Security at the top of the page.

  2. Click Create and manage API tokens from the API token section in the central part of the window.

image-20241014-125333.png
  1. Click Create API token.

  1. Give a label to your API token

  2. Click Create.

The token is ready for use. Make sure to copy the token before you close this dialog, as it is impossible to see the token later.

Creating the credentials for Atlassian

Below are the steps to create new Atlassian credentials:

  1. Go to Administration > Credentials.

  2. Click the Add credentials button;

  3. Click the Atlassian card;

  4. Name your credentials, e.g. Atlassian account Jean;

  5. Select who to share the credentials with. This will determine who can use your credentials in the data sources. If you want to keep these credentials private, select Only me. If you want to share them with other builders, select Builders.

  6. Type the Connection URL of your Atlassian tenant, such as https://mytenant.atlassian.net.

  7. Provide the Username (= email address) to connect to this Atlassian tenant.

  8. Provide the API key associated with the given Username.

  9. Click Add credentials on the top right of the page to finalize the creation.

The new credentials are now available in the Credentials list. You can now use them when creating a new Atlassian Confluence data source.

What’s next?

Learn how to create an Atlassian Confluence data source that uses your credentials by reading this page: Atlassian Confluence.