Skip to main content

Confluence

This page contains the setup guide and reference information for the Confluence source connector.

Prerequisites

  • Atlassian API Token
  • Your Confluence domain name
  • Your Confluence login email

Setup guide

Step 1: Create an API Token

For detailed instructions on creating an Atlassian API Token, please refer to the official documentation.

Step 2: Set up the Confluence connector in Airbyte

  1. Log in to your Airbyte Cloud account, or navigate to the Airbyte Open Source dashboard.
  2. From the Airbyte UI, click Sources, then click on + New Source and select Confluence from the list of available sources.
  3. Enter a Source name of your choosing.
  4. In the API Token field, enter your Atlassian API Token.
  5. In the Domain name field, enter your Confluence domain name.
  6. In the Email field, enter your Confluence login email.
  7. Click Set up source and wait for the tests to complete.

Supported sync modes

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncNo
Incremental - Dedupe SyncNo
SSL connectionNo
NamespacesNo

Supported streams

note

The audit stream requires a Standard or Premium plan.

Data type mapping

The Confluence Cloud REST API uses the same JSONSchema types that Airbyte uses internally (string, date-time, object, array, boolean, integer, and number), so no type conversions happen as part of this source.

Performance considerations

The Confluence connector should not run into Confluence API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Reference

Config fields reference

Field
Type
Property name
string
email
string
api_token
string
domain_name

Changelog

Expand to review
VersionDatePull RequestSubject
0.2.62024-06-1539495Fix parameters as comma seperated single string
0.2.52024-06-0639261[autopull] Upgrade base image to v1.2.2
0.2.42024-05-1438137Make connector compatible with the builder
0.2.32024-04-1937143Upgrade to CDK 0.80.0 and manage dependencies with Poetry.
0.2.22024-04-1537143Base image migration: remove Dockerfile and use the python-connector-base image
0.2.12024-04-1237143schema descriptions
0.2.02023-08-1429125Migrate Confluence Source Connector to Low Code
0.1.32023-03-1323988Add view and storage to pages body, add check for stream Audit
0.1.22023-03-0623775Set additionalProperties: true, update docs and spec
0.1.12022-01-319831Fix: Spec was not pushed to cache
0.1.02021-11-057241🎉 New Source: Confluence