Skip to main content

Atlassian Confluence

Atlassian Confluence is a team collaboration and knowledge management platform designed for creating, organizing, and sharing documentation, meeting notes, project plans, and team knowledge bases. It serves as a centralized workspace where teams can document processes, maintain wikis, create technical documentation, and collaborate on content in real-time.

CategoryCollaboration
DirectionQuery source
Sign-inCloud (Email + API Token), Data Center (Personal Access Token)
Query languagesSQLite
Websiteatlassian.com

Before you start​

Huntbase can sign in to Atlassian Confluence with any of these methods: Cloud (Email + API Token), Data Center (Personal Access Token). Pick one, create the credential in Atlassian Confluence, then keep it to hand for the Connect step.

Cloud (Email + API Token)​

Atlassian Cloud authentication using your account email and an API token.

  1. Sign in to https://id.atlassian.com/manage-profile/security/api-tokens as the account Huntbase should use.
  2. Select Create API token, give it a name, and choose an expiration date (1 to 365 days).
  3. Select Create, then Copy to clipboard. You can't view the token again.

Data Center (Personal Access Token)​

Confluence Data Center authentication using a Personal Access Token (PAT).

  1. In Confluence Data Center, select your avatar, then Settings › Personal access tokens.
  2. Select Create token, enter a name, and optionally set an expiry.
  3. Select Create and copy the token before you select Close. You can't see it again.
Watch out for
  • A Data Center personal access token matches the current permission level of the user who creates it, so create it as a user who can read only the spaces you want searched.
  • Personal access tokens need Confluence Data Center or Server 7.9 or later.

For the vendor's own instructions, see Atlassian API token documentation.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect Atlassian Confluence​

  1. Go to Connections and click New connection, or click New connection on the Atlassian Confluence product page.
  2. On Product, pick Atlassian Confluence and choose the Owner.
  3. On Details, give the connection a Name and, optionally, a Description.
  4. On Connect, fill in the settings and credentials described below.
  5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Settings​

Where your Atlassian Confluence lives:

FieldRequiredNotes
Deployment TypeNocloud (the default) or datacenter. One of cloud, server. Defaults to cloud.
Base URLYesYour site URL, such as https://your-domain.atlassian.net/ for Cloud.
Username (Email)NoThe email address of the Atlassian account that owns the API token. Required for Cloud.

Credentials​

Choose a Method, enter a Credential label (for example Production), then fill in the fields for that method.

Cloud (Email + API Token)​

FieldRequiredNotes
API Token / Personal Access TokenYesSecret — not shown again after you save it.

Data Center (Personal Access Token)​

FieldRequiredNotes
API Token / Personal Access TokenYesSecret — not shown again after you save it.

Query it​

Once connected, Atlassian Confluence can serve these languages in a query tab, and Scout can use it when you ask in Auto:

LanguageUse it for
SQLiteSQL across this source and every other connected source.

Next steps​