Breadcrumbs

Confluence

This guide explains what you, as the customer, need to provide to enable the integration between your Confluence CMS and our platform.

1. Prerequisites

Before proceeding, ensure you have the following:

  • Admin access to your Confluence instance.

  • Access to the Atlassian account to generate an API Key.

2. Retrieve Confluence Base URL

Steps to Find the Base URL

  1. Log in to your Confluence instance.

  2. Go to the Administration menu and select General Configuration.

  3. Click on Edit.

  4. Copy the Server Base URL. Important: For Confluence Cloud, the Base URL must include /wiki at the end.

    • Example: <https://your-domain.atlassian.net/wiki>

3. Generate API Key

Steps to Generate API Key

  1. Log in to your Atlassian account at Atlassian account.

  2. Click on Create API Token.

  3. Provide a name for the API token (e.g., "Marketplace Integration").

  4. Select an expiration date for the token (1 to 365 days).

  5. Click Create.

  6. Copy the API token and save it securely, as it will not be displayed again.

Important: API tokens expire based on the expiration date you set (up to 365 days). When a token expires, the integration will stop syncing and return authentication errors. To avoid disruption, regenerate the token before it expires and update the API Key in the Marketplace platform.

Note: The user account associated with the email must have read access to the Confluence spaces you want to sync.

4. Share Details with the Delivery Team

Once you have completed the setup, share the following details with the delivery team:

  • Base URL

  • API Key

  • Email ID (used to log in to Confluence)