Confluence

Required Scopes

To configure a Sync for Confluence, you need to request the following scopes from your Atlassian OAuth application:

Learn more about configuring scopes for your app in Adding Integrations.

Confluence supports the following Synced Objects:

Files: Pages in Confluence will be synced as HTML files.
Permissions: Permissions for pages and spaces will be synced, including spaces, groups, and page-level restrictions.

Send a request to Enable Sync to start a file sync. Syncs for Confluence can be created with one of the following configurations:

Space Sync: All pages in the specified space will be synced.
Sync of specific pages: A group of specific pages and their descendants will be synced.
Sync of one page: A specific page and its descendants will be synced.

Example

{
    "integration": "confluence",
    "pipeline": "files",
    "configuration": {
        "spaceId": "123456789"
    }
}

Configuration options:

spaceId

string

required

A Confluence Space ID to limit the Sync scope to pages within a specific space.

Example

{
    "integration": "confluence",
    "pipeline": "files",
    "configuration": {
        "pageIds": ["987654321"]
    }
}

Configuration options:

pageIds

string[]

required

A list of Confluence Page IDs to limit the Sync scope to. All specified pages and their descendants will be synced.

Example

{
    "integration": "confluence",
    "pipeline": "files",
    "configuration": {
        "pageId": "987654321"
    }
}

Configuration options:

pageId

string

required

A Confluence Page ID to limit the Sync scope to a specific page and its descendants.