Confluence

Confluence is a collaboration and knowledge management platform that helps teams create, organize, and share content, enabling better collaboration and documentation across organizations.

Power end-to-end data operations for your Confluence API with Nexla. Our bi-directional Confluence connector is purpose-built for Confluence, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Confluence or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Confluence workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Confluence credential, you need to obtain authentication credentials from your Confluence account. Confluence uses Basic Authentication with an Atlassian account username and API token combination to authenticate API requests.

To use Confluence with Nexla, you need:

• Access to your Confluence account
• A Confluence account with appropriate permissions to access the resources you want to work with
• Your Atlassian account username for Basic Authentication
• Your API token for Basic Authentication (not your password)
• Your Confluence domain

The Confluence API requires your domain, which is the base domain of your Confluence instance (e.g., your-domain.atlassian.net). The API token is different from your password and must be generated from your Atlassian account settings. For detailed information about Confluence authentication, API token setup, and available resources, refer to the Confluence API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Atlassian account username	Yes	No	Atlassian account username
API token	Yes	Yes	API token
Domain	Yes	No	Your Domain

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Confluence

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Atlassian account username in the Atlassian account username field. This is the username associated with your Atlassian account that will be used for Basic Authentication.

4. Enter your Confluence API token in the API token field. This is the API token you generated from your Atlassian account settings. The API token is used together with your username for Basic Authentication. Note: The API token is different from your password and must be generated from your Atlassian account settings.

5. Enter your Confluence domain in the Domain field. This should be the base domain of your Confluence instance (e.g., your-domain.atlassian.net) without the protocol (https://) or path. The domain is used to construct the complete API endpoint URLs for all API requests.

   Keep your authentication credentials secure and do not share them publicly. The credentials provide access to your Confluence account and should be treated as sensitive information. Basic Authentication credentials are sent in the Authorization header for all API requests to the Confluence API. The API token is different from your password and must be generated from your Atlassian account settings. The domain determines which Confluence instance your credential will access. For detailed information about obtaining and managing API tokens, see the Confluence API documentation.

6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Confluence connector tile, then select the credential that will be used to connect to the Confluence instance, and click Next; or, create a new Confluence credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Confluence endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get Pages

This endpoint returns all pages. Use this endpoint when you need to access page content, page metadata, or page information from your Confluence instance.

• This endpoint automatically retrieves all pages from your Confluence instance. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://{domain}/wiki/api/v2/pages?limit=250 where {domain} is your Confluence domain from the credential configuration. The endpoint URL is automatically constructed based on your credential's domain configuration.
• The endpoint uses URL-based pagination, automatically fetching additional pages as needed using the next URL from the response. When a response includes a _links.next value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results.
• The endpoint will return all pages in your Confluence instance. The response data is extracted from the results array in the API response ($.results[*]), with each page record processed individually.

This endpoint supports pagination through the next URL mechanism. When a response includes a _links.next value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results. The endpoint uses URL-based pagination (iteration.type: paging.next.url) through the _links.next mechanism. The response data path is $.results[*], which extracts all items from the results array in the API response. The endpoint limits results to 250 items per request. For detailed information about retrieving pages, see the Confluence API documentation.

Get Spaces

This endpoint returns all spaces. The results will be sorted by id ascending. Use this endpoint when you need to access space information, space settings, or space metadata from your Confluence instance.

• This endpoint automatically retrieves all spaces from your Confluence instance. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://{domain}/wiki/api/v2/spaces?limit=250 where {domain} is your Confluence domain from the credential configuration. The endpoint URL is automatically constructed based on your credential's domain configuration.
• The endpoint uses URL-based pagination, automatically fetching additional pages as needed using the next URL from the response. When a response includes a _links.next value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results.
• The endpoint will return all spaces in your Confluence instance, sorted by ID in ascending order. The response data is extracted from the results array in the API response ($.results[*]), with each space record processed individually.

This endpoint supports pagination through the next URL mechanism. When a response includes a _links.next value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results. The endpoint uses URL-based pagination (iteration.type: paging.next.url) through the _links.next mechanism. The response data path is $.results[*], which extracts all items from the results array in the API response. The endpoint limits results to 250 items per request. For detailed information about retrieving spaces, see the Confluence API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Confluence data sources can also be manually configured to ingest data from any valid Confluence API v2 endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, and path to data.

Confluence API endpoints typically follow the pattern https://{domain}/wiki/api/v2/{endpoint_path}, where {domain} is your Confluence domain. Confluence API responses typically use a results array ($.results[*]) to contain the data for list endpoints, or a root-level object for single resource endpoints. The endpoint requires Basic Authentication with your username and API token, which is handled automatically by your credential configuration.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Confluence data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Confluence destination, and select the Send to Destination option from the menu. Select the Confluence connector from the list of available destination connectors, then select the credential that will be used to connect to the Confluence organization, and click Next; or, create a new Confluence credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Confluence endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create page

This endpoint creates a new page in your Confluence instance. Pages are created as published by default unless specified as a draft in the status field. Use this endpoint when you need to create pages from your data sources, such as importing documentation or creating new content.

• The endpoint uses POST requests to https://{domain}/wiki/api/v2/pages where {domain} is your Confluence domain from the credential configuration. The endpoint URL is automatically constructed based on your credential's domain configuration.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the page data to create. The request body should follow the Confluence API v2 specification for creating pages, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a page. If you need to create multiple pages, you can send multiple records, but each will be processed as a separate request.

Pages are created as published by default unless you specify a draft status in the status field of the request body. The request body must be properly formatted JSON that matches the Confluence API v2 specification for creating pages. The endpoint requires Basic Authentication with your username and API token, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating pages, including required fields, field names, and request formats, see the Confluence API documentation.

Create footer comment

This endpoint creates a footer comment in your Confluence instance. Use this endpoint when you need to create footer comments from your data sources, such as adding comments to pages or creating discussion threads.

• The endpoint uses POST requests to https://{domain}/wiki/api/v2/footer-comments where {domain} is your Confluence domain from the credential configuration. The endpoint URL is automatically constructed based on your credential's domain configuration.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the footer comment data to create. The request body should follow the Confluence API v2 specification for creating footer comments, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a footer comment. If you need to create multiple footer comments, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Confluence API v2 specification for creating footer comments. The endpoint requires Basic Authentication with your username and API token, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating footer comments, including required fields, field names, and request formats, see the Confluence API documentation.

Manual configuration

Confluence destinations can also be manually configured to send data to any valid Confluence API v2 endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, and request body format.

Confluence API endpoints typically follow the pattern https://{domain}/wiki/api/v2/{endpoint_path}, where {domain} is your Confluence domain. The Confluence API v2 primarily uses POST requests for data writing operations and typically uses JSON format for request bodies. The endpoint requires Basic Authentication with your username and API token, which is handled automatically by your credential configuration.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Confluence endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Confluence endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.