Skip to main content

Sync Confluence pages to asset Readmes
App

You can sync Confluence page content into asset Readmes using the Confluence integration manager app. The workflow reads Confluence URLs from the Resource attribute of assets, fetches the page content via the Confluence API, and writes the converted content into each asset's Readme so that documentation in Confluence and in Atlan stay aligned without manual copy-paste.

If your setup doesn't use the Resource attribute, or you want to sync Confluence content into glossaries or use AI-assisted workflows, you can use Atlan MCP with your AI assistant for more flexible, platform-level options.

The app supports hyperlinks, images, code blocks, and basic HTML. Links to other Confluence pages are migrated as-is. Readmes have a 32K character limit; any content beyond that limit is omitted. This guide explains how to configure the workflow (including Atlan and Confluence credentials and filters) and how to run and review the results.

Prerequisites​

Before you begin, make sure you have:

  • Access to the Confluence integration manager app in your Atlan workspace. If you don't see it when creating a new workflow, contact your Atlan administrator or Atlan support.
  • Admin or workflow permissions in Atlan so you can create and run workflows.
  • A Confluence API token and the full Confluence username (for example, [email protected]) with access to the pages you want to sync.
  • Assets in Atlan that already have Confluence page URLs set in their Resource attribute. The app only processes assets that contain the Confluence link you want to migrate.

Configure workflow​

  1. In your Atlan workspace, go to the homepage and click New workflow in the top navigation bar.

  2. Search for Confluence integration manager, and then select Set up workflow.

  3. In Atlan credentials, enter your Atlan API Token. This token is used for authentication and for populating the filter dropdowns (for example, connector and connection lists) in the workflow UI.

  4. In Confluence credentials, provide the following:

    • Confluence API Token: The API token that has access to the Confluence pages you want to migrate. Create it in your Confluence or Atlassian account settings.

    • Confluence Username: The full Confluence username. Use the complete value; partial values (for example, john.doe instead of [email protected]) cause authentication failures.

      [email protected]

    • Confluence Base URL: The base domain of your Confluence instance only. Don't include paths such as /wiki or /test, or the https:// protocol.

      atlanhq.atlassian.net

  5. In Filters, optionally narrow which assets are processed. Each filter has an operator (dropdown) and a value (dropdown or free text). The app applies a filter only when both are set. You can filter by Connector, Connection, Asset Type, or Qualified Name. Use filters to target a specific connection, asset type, or set of assets so the workflow runs only on the assets you intend to update.

  6. Schedule and run the workflow. Run it once to sync Confluence content to Readmes for the assets that match your filters, or set a recurring schedule to keep Readmes up to date as you add or change Confluence links in asset Resources.

The Confluence integration manager app queries Atlan for assets matching your filters, reads the Confluence URLs from each asset's Resource attribute, fetches the page content via the Confluence API, converts the content for Readme compatibility, and updates asset Readmes in batches.

Review synced Readmes​

  1. After you configure and run the workflow, the app updates the Readme of each asset that had a Confluence URL in its Resource attribute and matched your filters.

  2. In Atlan, open any of those assets and check the Readme tab to confirm the Confluence content appears as expected. If content is missing or truncated, the source Confluence page may exceed the 32K character limit or use unsupported content types.

  3. To sync more assets, add Confluence URLs to the Resource attribute of the assets you want to update, then run the workflow again (or wait for the next scheduled run).

Need help?​

If you encounter issues when configuring or running the workflow, or if authentication fails, see Troubleshooting Confluence Integration Manager or contact Atlan support.

See also​

  • Add a resource: Add links (including Confluence URLs) to the Resource attribute of assets so the Confluence integration manager can sync them to Readmes.
  • Use MCP in chat-based AI tools: Use Atlan MCP with your AI assistant to sync or align Confluence content with Atlan (for example, into glossaries or asset Readmes) without relying on the Resource attribute. See Align glossary with documentation and Update and enrich asset metadata for examples.
  • Troubleshooting Confluence Integration Manager: Resolve common credential and authentication issues.