By integrating Confluence with DX, you can analyze documentation contributions and metrics such as new docs created and updates. Please visit our schema explorer to see what data DX imports.

Prerequisites

To connect Confluence to DX, you need:

a Managed Account
a service account and API token

Setup instructions

Step 1

Create a Confluence service account to be used for DX.
The service account must have access to the spaces that you want to import.

Step 2

Create an API token from the Account Security section.
Copy your token (beginning with ATATT3x) into your notes to use it in the next step.

Step 3

Navigate to the connector setup form in DX.
Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

API Reference

The table below lists the specific API endpoints that are used by DX.

Endpoint	Documentation
/wiki/api/v2/spaces	Get Spaces
/wiki/api/v2/pages	Get Pages
/wiki/api/v2/pages/{pageId}/versions	Get Page Versions
/wiki/api/v2/pages/{pageId}/labels	Get Page Labels
/wiki/api/v2/users-bulk	Bulk user lookup

Errors

The table below lists potential error codes when adding a connection in DX.

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your API token does not have the permissions required by DX.

Troubleshooting

User filtering doesn't work

DX matches Confluence user emails with DX user emails to map user identities and teams. DX can only import Confluence user emails when profile visibility is set to public, which is the default for Managed accounts but not for Unmanaged accounts.

If your Confluence workspace is currently an Unmanaged account, please migrate to a Managed account to enable the importing of new user emails.