/
Creating an Atlassian connection

Creating an Atlassian connection

For Koji to answer users' queries based on the Confluence knowledge related to your project, you will need to:

  1. Create an Atlassian connection.

  2. Create an Atlassian Confluence data source using this connection.

  3. Select the data source to use in Koji settings.

This page is dedicated to explaining how to create an Atlassian connection.

An Atlassian connection is an authentication feature that will allow Koji to access the knowledge from your Confluence knowledge base via an Atlassian data source.

Adding an Atlassian connection

Before creating an Atlassian connection, you must first ensure you possess an Atlassian account with an API key tied to the Atlassian tenant on which Koji is installed to be able to access the content from your Atlassian tenant.

Generating the Atlassian API key

The API key (or API token) is used as a password in the Atlassian connection 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.

image-20241014-125450.png

  1. Give a label to your API token

  2. Click Create.

image-20241014-125806.png

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.

image-20241014-125725.png

Creating the connection to Atlassian

Now that you have an account with an API key, you can create a new Atlassian connection:

  1. Go to Platform management > Configuration > Connections.

  2. Click Add connection to create a new connection;

  3. Select the Atlassian connection type;

  4. Give a name to your connection;

  5. Select who to share the connection with. This will determine who can edit the connection.

  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 site.

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

  9. Click Create.

image-20250707-123627.png

The new connection is now available in the Connections list. You can now use it when creating a new Atlassian Confluence data source.

Note that the connection will fail if the provided credentials are invalid.

Verifying a connection

You can test the validity of an existing connection by clicking the Verify button when viewing the configuration of the connection. If the connection is invalid, its status will switch to Failed, meaning you need to review its configuration.

image-20250707-123848.png

In what cases can verified existing connections be marked as Failed?

  • The given password has changed. The creator should check if this is the case and update the connection with the new password.

  • The API key (for an Atlassian connection) has expired. This can happen if the person who created the API key sets an expiration date. In this case, they should create a new API key in Atlassian and update the connection in the back office.

  • The permissions have changed or have been revoked. You may need to check those directly in the third-party interface.

What’s next?

The next step consists of creating an Atlassian Confluence data source.

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