Skip to main content

Setting up an integration with Confluence

Updated yesterday

What is needed from the customer?

For the Confluence integration, a personal user account or a service account needs to be used to generate the required API key.

  • URL including space key: https://<CUSTOMERNAME>.atlassian.net/wiki/spaces/<SPACEKEY> OR in the case of a scoped token: https://api.atlassian.com/ex/confluence/<CLOUD-ID> (see the instructions at the bottom for getting the cloud id)`

  • Username (email)

  • API key (classic or scoped)

  • Space home page id: can be found with the following curl:
    ​

curl --location 'https://<URL>/wiki/api/v2/spaces' \ 
--header 'Authorization: Basic <base64-of-email:apiKey>'

For the API key, you can navigate straight to this URL, or follow the steps below in the Confluence UI.

Classic token:

Scoped token:

The following read AND search scopes:

read:confluence-content.all 
read:confluence-space.summary
read:content:confluence
read:content-details:confluence
read:space-details:confluence
read:space:confluence
search:confluence

To get your cloud id, you can run the following curl:

curl --location 'https://<CUSTOMERNAME>.atlassian.net/_edge/tenant_info' \ --header 'Authorization: Basic <base64-of-email:apiKey>'

Did this answer your question?