Confluence
If you’re new to Unstructured, read this note first.
Before you can create a source connector, you must first sign up for Unstructured and get your Unstructured API key. After you sign up, the Unstructured user interface (UI) appears, which you use to get the key. To learn how, watch this 40-second how-to video.
After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.
You can also create source connectors with the Unstructured user interface (UI). Learn how.
If you need help, reach out to the community on Slack, or contact us directly.
You are now ready to start creating a source connector! Keep reading to learn how.
Ingest your files into Unstructured from Confluence.
The requirements are as follows.
-
A Confluence Cloud account or Confluence Data Center installation.
-
The site URL for your Confluence Cloud account or Confluence Data Center installation.
-
A user in your Confluence Cloud account or Confluence Data Center installation.
-
The user must have the correct permissions in your Conflunce Cloud account or Confluence Data Center installation to access the target spaces and pages.
-
One of the following:
- For Confluence Cloud or Confluence Data Center, the target user’s name or email address, and password. Change a Confluence Cloud user’s password. Change a Confluence Data Center user’s password.
- For Confluence Cloud only, the target user’s name or email address, and API token. Create an API token.
- For Confluence Data Center only, the target user’s personal access token (PAT). Create a PAT.
-
Optionally, the names of the specific spaces in the Confluence instance to access.
The following video provides related setup information for Confluence Cloud:
To create a Confluence source connector, see the following examples.
Replace the preceding placeholders as follows:
<name>
(required) - A unique name for this connector.<url>
(required) - The URL to the target Confluence Cloud instance.<max-num-of-spaces>
- The maximum number of Confluence spaces to access within the Confluence Cloud instance. The default is500
unless otherwise specified.<max-num-of-docs-from-each-space>
- The maximum number of documents to access within each space. The default is150
unless otherwise specified.spaces
is an array of strings, with each<space-name>
specifying the name of a space to access, for example:["luke","paul"]
. By default, if no space names are specified, and the<max-num-of-spaces>
is exceeded for the instance, be aware that you might get unexpected results.extract_images
- Set totrue
to download images and replace the HTML content with Base64-encoded images. The default isfalse
if not otherwise specified.extract_files
- Set totrue
to download any embedded files in pages. The default isfalse
if not otherwise specified.
For API token authentication:
<username>
- The name or email address of the target user.<api-token>
- The user’s API token value.- For
cloud
,true
if you are using Confluence Cloud. The default isfalse
if not otherwise specified.
For personal access token (PAT) authentication:
<personal-access-token>
- The target user’s PAT value.cloud
should always befalse
.
For password authentication:
<username>
- The name or email address of the target user.<password>
- The user’s password.- For
cloud
,true
if you are using Confluence Cloud. The default isfalse
if not otherwise specified.
Was this page helpful?