Confluence API
Last updated
Was this helpful?
Last updated
Was this helpful?
The Confluence API scraper retrieves data using Confluence's .
At the beginning of the URL within your Confluence environment, you'll find your company’s unique domain. It typically follows the format: yourCompanyName.atlassian.net. In this example, you should enter yourCompanyName into the field.
Add the email address of the user that the scraper will authenticate as. This can be your personal email or a dedicated "API user" account created for automation purposes.
Here, you should enter an API token that you generate in Confluence.
Enter the space keys for the Confluence spaces you want to include in the scrape. You can find a space key in the space settings. It will look something like in the image below:
If no space keys are entered, the scraper will automatically retrieve content from all available "Global" and "Knowledge Base" spaces.
To create an API token in Confluence, go to and log in to the Confluence account associated with the email entered in the "Email" field. Then, navigate to the API token management page and click "Create API Token" to generate a new one. Note that the token will only be displayed once—be sure to save it securely for future use.
