Skip to main content

Confluence

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Marketplace
Connector Version
1.0.23 (last updated 14 days ago)
Definition ID
cf40a7f8-71f8-45ce-a7fa-fca053e4028c

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

Prerequisites​

  • A Confluence Cloud site, for example your-domain.atlassian.net
  • An Atlassian account email for a user who can access the site
  • An Atlassian API token for that account

Setup guide​

Step 1: Create an API token​

Create an Atlassian API token in your Atlassian account. For detailed instructions, see Manage API tokens for your Atlassian account.

This connector authenticates to your Confluence site URL with HTTP Basic authentication using your Atlassian account email and API token. If you create a scoped API token, Atlassian requires requests to use https://api.atlassian.com/ex/confluence/{cloudId}. This connector doesn't support scoped API tokens.

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 + 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 Cloud hostname, for example your-domain.atlassian.net. Don't include https://.
  6. In the email field, enter the Atlassian account email you used to create the API token.
  7. Click Set up source and wait for the tests to complete.

Permissions​

The connector can only sync records that the configured Atlassian user can view in Confluence.

  • The pages, blog_posts, space, and group streams require the user to have permission to access the Confluence site.
  • The pages and blog_posts streams only return content the user can view in the corresponding space.
  • The space stream only returns spaces the user can view.
  • The audit stream requires the Confluence Administrator global permission. The audit log is available only on Standard and Premium Confluence plans.

Supported sync modes​

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

Supported streams​

All streams sync in Full Refresh mode. The pages, blog_posts, and space streams use Confluence REST API v2 cursor-based pagination. The audit and group streams use Confluence REST API v1 offset-based pagination.

Data type mapping​

The Confluence Cloud REST API uses the same JSON Schema types that Airbyte uses internally: string, date-time, object, array, boolean, integer, and number. No type conversions happen as part of this source.

Performance considerations​

The Confluence Cloud REST API uses rate limits and quotas. Atlassian doesn't publish fixed limits for this API. The connector automatically retries rate-limited requests. If you see rate limit issues that aren't retried successfully, contact Airbyte Support or post in the Airbyte community Slack.

Reference​

The connector uses these configuration fields for programmatic setup with PyAirbyte, Terraform, or the Airbyte API:

  • email: Atlassian account email for the user whose permissions determine which Confluence records Airbyte can sync.
  • api_token: Atlassian API token for the email account. Use an API token without scopes.
  • domain_name: Confluence Cloud hostname, for example your-domain.atlassian.net. Don't include the protocol.

All streams use Full Refresh sync. Version 1.0.23 fixed a discovery issue that incorrectly advertised Incremental sync for streams that don't define cursors. If an existing connection selected Incremental sync for this connector, refresh the source schema and set the affected streams back to Full Refresh.

Reference​

Config fields reference

Field
Type
Property name
string
api_token
string
domain_name
string
email

Changelog​

Expand to review
VersionDatePull RequestSubject
1.0.232026-05-0777776Bump base image to source-declarative-manifest:7.18.1 so streams without cursors no longer advertise incremental sync
1.0.222026-05-0777820Switch v2 streams (pages, blog_posts, space) to cursor-based pagination
1.0.212025-12-1970941Update dependencies
1.0.202025-11-2569919Update dependencies
1.0.192025-10-2966333Update dependencies
1.0.182025-09-0965889Update dependencies
1.0.172025-08-2365281Update dependencies
1.0.162025-08-0964777Update dependencies
1.0.152025-08-0264318Update dependencies
1.0.142025-07-2663958Update dependencies
1.0.132025-07-1963597Update dependencies
1.0.122025-07-1263027Update dependencies
1.0.112025-07-0562797Update dependencies
1.0.102025-06-2862380Update dependencies
1.0.92025-06-2261996Update dependencies
1.0.82025-06-1461176Update dependencies
1.0.72025-05-2460406Update dependencies
1.0.62025-05-1059921Update dependencies
1.0.52025-05-0359442Update dependencies
1.0.42025-04-2658851Update dependencies
1.0.32025-04-1958320Update dependencies
1.0.22025-04-1257774Update dependencies
1.0.12025-04-0557269Update dependencies
1.0.02025-04-0155876Migrate API to V2
0.3.162025-03-2956506Update dependencies
0.3.152025-03-2255966Update dependencies
0.3.142025-03-0855335Update dependencies
0.3.132025-03-0154978Update dependencies
0.3.122025-02-2254431Update dependencies
0.3.112025-02-1553715Update dependencies
0.3.102025-02-0853317Update dependencies
0.3.92025-02-0152865Update dependencies
0.3.82025-01-2552314Update dependencies
0.3.72025-01-1851633Update dependencies
0.3.62025-01-1151109Update dependencies
0.3.52024-12-2850564Update dependencies
0.3.42024-12-2149541Update dependencies
0.3.32024-12-1248263Update dependencies
0.3.22024-10-2847553Update dependencies
0.3.12024-08-1644196Bump source-declarative-manifest version
0.3.02024-08-1544162Refactor connector to manifest-only format
0.2.162024-08-1043573Update dependencies
0.2.152024-08-0343053Update dependencies
0.2.142024-07-2742699Update dependencies
0.2.132024-07-2042333Update dependencies
0.2.122024-07-1341857Update dependencies
0.2.112024-07-1041398Update dependencies
0.2.102024-07-0941270Update dependencies
0.2.92024-07-0641013Update dependencies
0.2.82024-06-2540436Update dependencies
0.2.72024-06-2240115Update dependencies
0.2.62024-06-1539495Fix parameters as comma separated 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
Was this page helpful?