Confluence

​

Overview

​

Authentication

​

How to configure and enable the Confluence Connector

​

Step 1: Access Atlassian Developer Console

1. Navigate to the Developer Console:
   Go to developer.atlassian.com/console/myapps/ and sign in with your Atlassian account that has administrator access to your Confluence workspace.
2. View Your Apps: You’ll see the “My apps” page where you can create and manage OAuth 2.0 integrations.

​

Step 2: Create a New OAuth 2.0 Integration

1. Click the “Create” button in the top right corner
2. Select “OAuth 2.0 integration” from the dropdown menu
3. Fill in the application details:
   • Name: Enter a meaningful name (e.g., “PipesHub Confluence Connector”)
   • Check the box to agree to Atlassian’s developer terms
4. Click “Create” to proceed

​

Step 3: Review Application Overview

• App ID: Your application’s unique identifier
• Distribution status: Whether the app is shared publicly
• Permissions: API scopes configured for the app
• Authorization: OAuth 2.0 (3LO) authorization settings

​

Step 4: Configure OAuth 2.0 Authorization

1. In the left sidebar, click “Authorization”
2. Find “OAuth 2.0 (3LO)” in the authorization types list
3. Click “Add” to enable OAuth 2.0 authorization for your app

4. Set the Callback URL:
   • You need to enter the redirect URI provided by PipesHub
   • To get this URL, open PipesHub in another tab, navigate to Settings → Connectors, find the Confluence connector, and click “Configure”
   • Copy the Redirect URI shown in the configuration dialog:

5. Paste the copied Redirect URI into the Callback URL field in Atlassian Developer Console
6. Click “Save changes”

​

Step 5: Add API Permissions

1. In the left sidebar, click “Permissions”
2. You’ll see a list of available Atlassian APIs
3. Add scopes for both User identity API and Confluence API

​

User Identity API Scopes

• read:account - View user profiles (required for user identification)

​

Confluence API Scopes

Classic Scopes

Granular Scopes

​

Step 6: Get OAuth 2.0 Credentials

1. In the left sidebar, click “Settings”
2. Scroll down to the “Authentication details” section
3. Copy the following credentials:
   • Client ID: Your app’s unique identifier
   • Secret: Your app’s client secret (click the copy button)

​

Step 7: Configure Connector in PipesHub

1. Return to the PipesHub Confluence configuration dialog (if you closed it, navigate to Settings → Connectors and click “Configure” on the Confluence connector)
2. The configuration dialog has two steps:
   • Step 1: Authentication - Enter OAuth credentials
   • Step 2: Sync Settings - Configure synchronization
3. Verify the Redirect URI displayed matches the callback URL you configured in Atlassian Developer Console (Step 4)
4. Enter your OAuth 2.0 credentials:
   • Client ID: From Step 6
   • Client Secret: From Step 6

5. Click “Next” to proceed to authentication

​

Step 8: Authorize the Connection

1. After saving the configuration, click “Authenticate” from the Quick Actions panel
2. You’ll be redirected to Atlassian’s authorization page
3. Select your Confluence site from the dropdown menu

4. Review the permissions being requested by the connector
5. Click “Accept” to grant access

6. You’ll be redirected back to PipesHub with a success message
7. The connector status will update to show “Authenticated”

​

Step 9: Configure Sync Settings

1. After successful authentication, configure your sync preferences:
   • Sync Strategy: Choose between “Scheduled” or “Manual”
   • Timezone: Select your preferred timezone for scheduled syncs
   • Sync Interval: Choose how often to sync (e.g., 1 hour, 6 hours, 24 hours)

2. Click “Save Configuration” to save your settings

​

Step 10: Configure Filters (Optional)

​

Sync Filters

1. Space Keys - Filter by Confluence spaces
   • Operator: In (include only) or Not In (exclude)
   • Value: Enter one or more space keys (e.g., ENG, MKT, PROD)
   • Note: Space keys are case-sensitive
   • Finding Space Keys: Check your space URL - https://yourinstance.atlassian.net/wiki/spaces/SPACEKEY/overview - the SPACEKEY is what you need
2. Page IDs - Filter specific pages (includes all child pages automatically)
   • Operator: In (include) or Not In (exclude)
   • Value: Enter one or more page IDs (e.g., 88375321, 90341377)
   • Note: When you specify a parent page, all its child pages are automatically included
   • Finding Page IDs: Check your page URL - https://yourinstance.atlassian.net/wiki/spaces/SPACE/pages/88375321/Page+Title - the number after /pages/ is the page ID
3. Blogpost IDs - Filter specific blogposts
   • Operator: In or Not In
   • Value: Enter one or more blogpost IDs
   • Finding Blogpost IDs: Check your blogpost URL - https://yourinstance.atlassian.net/wiki/spaces/SPACE/blog/2024/12/09/12345678/Blog+Title - the number after /blog/YYYY/MM/DD/ is the blogpost ID
4. Modified Date - Filter by last modification date
   • Operators: Is After, Is Before, or Is Between
   • Use case: Sync only recently updated content (e.g., content modified in the last 6 months)
5. Created Date - Filter by creation date
   • Operators: Is After, Is Before, or Is Between
   • Use case: Sync only newly created content or exclude legacy documentation

​

Indexing Filters

• Pages Section:
  • Index Pages (default: enabled)
  • Index Page Attachments (default: enabled)
  • Index Page Comments (default: enabled)
• Blogposts Section:
  • Index Blogposts (default: enabled)
  • Index Blogpost Attachments (default: enabled)
  • Index Blogpost Comments (default: enabled)

• Sync only Engineering space: Space Keys → Operator: In, Value: ENG
• Exclude archived spaces: Space Keys → Operator: Not In, Value: ARCHIVE, OLD
• Sync specific documentation tree: Page IDs → Operator: In, Value: 88375321
• Recent content only: Modified Date → Operator: Is After, Date: 2024-06-01
• Index pages but not attachments: Disable “Index Page Attachments” toggle

​

Step 11: Enable the Connector

1. After configuration is complete, toggle the connector status to “Enable”
2. You can do this by:
   • Using the toggle switch next to “Connector Status”
   • Or clicking “Enable” in the Quick Actions panel

3. The connector will verify credentials and begin initial synchronization
4. Wait for the status to show “Active” or “Syncing”
5. Monitor the Indexing Progress to track sync completion

​

Supported Features

• Spaces: All accessible spaces and their configurations
• Pages: Full page content with formatting preserved
• Blog Posts: All blog post content and metadata
• Comments: Comments on pages and blog posts
• Attachments: Files attached to pages and blog posts
• Users: User profiles and account information
• Groups: User groups and memberships
• Permissions: Content restrictions and space permissions
• Folders: Folder structure and organization
• Audit Logs: Activity records for compliance

​

Data Sync Behavior

​

Initial Sync

• Fetches all accessible content from connected Confluence spaces
• Indexes pages, blog posts, attachments, and comments
• Respects user permissions for content visibility
• Duration depends on the size of your Confluence workspace

​

Incremental Sync

• Uses timestamp-based synchronization to detect changes
• Only syncs new or modified content since last sync
• Efficiently handles additions, updates, and deletions
• Reduces API calls and sync duration

​

Permission Handling

• Syncs content based on the authenticating user’s permissions
• Each user sees only content they have access to in Confluence
• Respects space permissions and page restrictions
• Maintains Confluence’s access control model

​

Troubleshooting

​

Common Issues

• Verify Client ID and Client Secret are correct
• Ensure you copied the full values without extra spaces
• Check that the OAuth app is active in Atlassian Developer Console
• Regenerate the secret if necessary and update PipesHub

• Ensure the Redirect URI in PipesHub exactly matches the callback URL in Atlassian
• Check for trailing slashes or protocol differences (http vs https)
• Update both configurations to use the same URL

• Verify you’re signing in with an account that has Confluence access
• Ensure your Confluence site is selected during authorization
• Check that all required API scopes are configured

• Verify the connector status shows “Active”
• Check that the authenticating user has access to Confluence content
• Ensure spaces are not restricted or archived
• Review sync logs for specific error messages

• OAuth 2.0 tokens may expire based on Atlassian’s policies
• Disable and re-enable the connector to re-authenticate
• Check if the OAuth app is still active in Developer Console

• Verify the authenticating user has read access to the content
• Check space permissions in Confluence
• Review page restrictions that may limit access

​

Confluence Cloud Compatibility

​

Useful Links

• Atlassian Developer Console: developer.atlassian.com/console/myapps/
• OAuth 2.0 (3LO) Documentation: developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/
• Confluence API Scopes Reference: developer.atlassian.com/cloud/confluence/scopes/