Skip to main content

Confluence

kapa provides an integration that enables pulling content your Confluence knowledge base.

Setup​

Step 1: Give kapa access to your confluence​

In order for kapa to authenticate itself against your Confluence istance it needs the following credentials:

  • Confluence URL: Confluence enterprise users have their own domain of the format https://companyname.atlassian.net.
  • Username: The username of a user who has access to the workspace is required. For everything except Confluence on-prem this is an email.
  • API Token: See here for instructions on how to create an API token for your Confluence.

Step 2: Filtering Pages​

There are filters available to restrict the pages which will be pulled by kapa. By default, all pages in a given Confluence workspace will be pulled.

  • Last updated after: Only fetch pages that were last updated after the selected date.
  • Spaces Include: Only include the selected Confluence Spaces, along with all the pages they contain.
  • Spaces Exclude: Exclude the selected Confluence Spaces, along with all the pages they contain.
  • Pages Include: Only include the selected pages.
  • Pages Exclude: Exclude the selected pages.
  • Pages Include With Children: Only include the selected pages, along with their sub-pages.
  • Pages Exclude With Children: Exclude the selected pages, along with their sub-pages.

FAQ​

How to create a Confluence API token?​

You need to generate an API token within Atlassian to grant kapa access to your Confluence.

To create an API token from your Atlassian account:

  1. Log in to https://id.atlassian.com/manage-profile/security/api-tokens.
  2. Click Create API token.
  3. From the dialog that appears, enter a memorable and concise Label for your token and click Create.
  4. Click Copy to clipboard, then paste the token to your script, or elsewhere to save:

API Token

Note: For security reasons it isn't possible to view the token after closing the creation dialog; if necessary, create a new token.

More information can be found on Atlassian's Support page.

You can now paste the token into the Source Configuration Form.

Why does kapa exclude macros when ingesting from Confluence?​

When reviewing pages ingested by kapa from Confluence, you may notice that some pages appear to have little or no content. This is because kapa is excluding macros when ingesting pages. Confluence macros are dynamic elements that use JavaScript to render content when a page is viewed in a web browser. However, when kapa accesses page content via the Confluence API, it receives only the raw page data. This raw data doesn't include the rendered output of these macros and hence kapa is forced to drop macros.