Skip to main content

Confluence

This connector captures data from Confluence into Flow collections via the Confluence Cloud REST API.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-confluence:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.

Supported data resources​

When you configure the connector, you specify your email, api and domain name

From your selection, the following data resources are captured:

resources​

Each resource is mapped to a Flow collection through a separate binding.

Prerequisites​

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

Configuration​

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the GitHub source connector.

  1. Create an API Token
  1. Set up the Confluence connector in Estuary Flow
  • Log into Estuary Flow and click "Captures".
  • Select "Create Capture" search for and click on "Confluence"
  • Enter a Capture Name
  • In the "API Token" field, enter your Atlassian API Token
  • In the "Domain Name" field, enter your Confluence Domain name
  • In the "Email" field, enter your Confluence login email
  • Click "Save and Publish"

Sample​

This sample specification reflects the manual authentication method.

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-confluence:dev
          config:
            credentials:
              api_token: PAT Credentials
            domain_name: estuary1.atlassian.net
            email: dave@estuary.dev
      bindings:
        - resource:
            stream: audit
            syncMode: full_refresh
          target: ${PREFIX}/audit
       {...}