Confluence

Confluence logo

Confluence

Configuration

Confluence source connector integrates with the Confluence REST API to extract content.

Connects to your Confluence instance.

It supports syncing spaces, pages, blog posts, comments, labels, and other content types. It converts Confluence pages to HTML format for content extraction and extracts embedded files and attachments from page content.

Authentication

This connector uses OAuth 2.0 authentication. You can connect through the Airweave UI or API using the OAuth flow.

Supported authentication methods:

  • OAuth Browser Flow (recommended for UI)
  • OAuth Token (for programmatic access)
  • Auth Provider (enterprise SSO)

Configuration Options

This connector does not have any additional configuration options.

Data Models

The following data models are available for this connector:

Schema for a Confluence Space.

Reference: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-spaces/

FieldTypeDescription
space_idstrUnique identifier for the space.
space_namestrDisplay name of the space.
space_keystrUnique key for the space.
space_typeOptional[str]Type of space (e.g. ‘global’).
descriptionOptional[str]Description of the space.
statusOptional[str]Status of the space if applicable.
homepage_idOptional[str]ID of the homepage for this space.
site_urlOptional[str]Base Confluence site URL.

Schema for a Confluence Page.

Pages are treated as FileEntity with HTML body saved to local file. Content is not stored in entity fields, only in the downloaded file.

Reference: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-pages/

FieldTypeDescription
content_idstrActual Confluence page ID.
titlestrTitle of the page.
space_idOptional[str]ID of the space this page belongs to.
space_keyOptional[str]Key of the space this page belongs to.
bodyOptional[str]HTML body or excerpt of the page.
versionOptional[int]Page version number.
statusOptional[str]Status of the page (e.g., ‘current’).
site_urlOptional[str]Base Confluence site URL.

Schema for a Confluence Blog Post.

Reference: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-posts/

FieldTypeDescription
content_idstrActual Confluence blog post ID.
titlestrTitle of the blog post.
space_idOptional[str]ID of the space this blog post is in.
space_keyOptional[str]Key of the space this blog post is in.
bodyOptional[str]HTML body of the blog post.
versionOptional[int]Blog post version number.
statusOptional[str]Status of the blog post (e.g., ‘current’).
site_urlOptional[str]Base Confluence site URL.

Schema for a Confluence Comment.

Reference: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comments/

FieldTypeDescription
comment_idstrUnique identifier for the comment.
parent_content_idOptional[str]ID of the content this comment is attached to.
parent_space_keyOptional[str]Key of the space the parent content belongs to.
textstrText/HTML body of the comment.
created_byOptional[Dict[str, Any]]Information about the user who created the comment.
statusOptional[str]Status of the comment (e.g., ‘current’).
site_urlOptional[str]Base Confluence site URL.

Schema for a Confluence Database object.

Note: The “database” content type in Confluence Cloud.

FieldTypeDescription
content_idstrActual Confluence database ID.
titlestrTitle or name of the database.
space_keyOptional[str]Space key for the database item.
descriptionOptional[str]Description or extra info about the DB.
statusOptional[str]Status of the database content item.

Schema for a Confluence Folder object.

Note: The “folder” content type in Confluence Cloud.

FieldTypeDescription
content_idstrActual Confluence folder ID.
titlestrName of the folder.
space_keyOptional[str]Key of the space this folder is in.
statusOptional[str]Status of the folder (e.g., ‘current’).

Schema for a Confluence Label object.

Reference: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-labels/

FieldTypeDescription
label_idstrUnique identifier for the label.
label_namestrDisplay name of the label.
label_typeOptional[str]Type of the label (e.g., ‘global’).
owner_idOptional[str]ID of the user or content that owns label.
site_urlOptional[str]Base Confluence site URL.

Schema for a Confluence Task object.

For example, tasks extracted from Confluence pages or macros.

FieldTypeDescription
task_idstrUnique identifier for the task.
content_idOptional[str]The content ID (page, blog, etc.) that this task is associated with.
space_keyOptional[str]Space key if task is associated with a space.
textstrText of the task.
assigneeOptional[Dict[str, Any]]Information about the user assigned to this task.
completedboolIndicates if this task is completed.
due_dateOptional[Any]Due date/time if applicable.

Schema for a Confluence Whiteboard object.

Note: The “whiteboard” content type in Confluence Cloud.

FieldTypeDescription
whiteboard_idstrUnique identifier for the whiteboard.
titlestrTitle of the whiteboard.
space_keyOptional[str]Key of the space this whiteboard is in.
statusOptional[str]Status of the whiteboard (e.g., ‘current’).

Schema for a Confluence Custom Content object.

Note: The “custom content” type in Confluence Cloud.

FieldTypeDescription
custom_content_idstrUnique identifier for the custom content.
titlestrTitle or name of this custom content.
space_keyOptional[str]Key of the space this content resides in.
bodyOptional[str]Optional HTML body or representation.
statusOptional[str]Status of the custom content item (e.g., ‘current’).