Confluence | Composio Docs

Overview

SLUG

CONFLUENCE

Description

A tool for team collaboration and knowledge management.

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to read:content:confluence,read:content-details:confluence,write:content:confluence,delete:content:confluence,read:space-details:confluence,read:analytics.content:confluence,read:audit-log:confluence,write:audit-log:confluence,read:configuration:confluence,write:configuration:confluence,read:page:confluence,write:page:confluence,delete:page:confluence,read:blogpost:confluence,write:blogpost:confluence,delete:blogpost:confluence,read:whiteboard:confluence,write:whiteboard:confluence,delete:whiteboard:confluence,read:database:confluence,write:database:confluence,delete:database:confluence,read:embed:confluence,write:embed:confluence,delete:embed:confluence,read:folder:confluence,write:folder:confluence,delete:folder:confluence,read:custom-content:confluence,write:custom-content:confluence,delete:custom-content:confluence,read:attachment:confluence,write:attachment:confluence,delete:attachment:confluence,read:comment:confluence,write:comment:confluence,delete:comment:confluence,read:template:confluence,write:template:confluence,read:label:confluence,write:label:confluence,read:content.permission:confluence,read:content.property:confluence,write:content.property:confluence,read:content.restriction:confluence,write:content.restriction:confluence,read:content.metadata:confluence,read:watcher:confluence,write:watcher:confluence,read:group:confluence,write:group:confluence,read:inlinetask:confluence,write:inlinetask:confluence,read:relation:confluence,write:relation:confluence,read:space:confluence,write:space:confluence,delete:space:confluence,read:space.permission:confluence,write:space.permission:confluence,read:space.property:confluence,write:space.property:confluence,read:user.property:confluence,write:user.property:confluence,read:space.setting:confluence,write:space.setting:confluence,read:user:confluence,read:task:confluence,write:task:confluence,offline_access

bearer_token

string

Tools

Create blog post

SLUG: CONFLUENCE_CREATE_BLOG_POST

Creates a new blog post in the space specified by the spaceid. by default this will create the blog post as a non-draft, unless the status is specified as draft. if creating a non-draft, the title must not be empty. currently only supports the storage representation specified in the body.representation enums below

Action Parameters

body

object

createdAt

string

private

boolean

spaceId

stringRequired

status

string

title

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create inline comment

SLUG: CONFLUENCE_CREATE_INLINE_COMMENT

Create an inline comment. this can be at the top level (specifying pageid or blogpostid in the request body) or as a reply (specifying parentcommentid in the request body). note the inlinecommentproperties object in the request body is used to select the text the inline comment should be tied to. this is what determines the text highlighting when viewing a page in confluence. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.

Action Parameters

blogPostId

string

body

object

inlineCommentProperties__textSelection

string

inlineCommentProperties__textSelectionMatchCount

integer

inlineCommentProperties__textSelectionMatchIndex

integer

pageId

string

parentCommentId

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create page

SLUG: CONFLUENCE_CREATE_PAGE

Creates a page in the space. pages are created as published by default unless specified as a draft in the status field. if creating a published page, the title must be specified. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the corresponding space. permission to create a page in the space.

Action Parameters

body

object

embedded

boolean

parentId

string

private

boolean

root__level

boolean

spaceId

stringRequired

status

string

title

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create space

SLUG: CONFLUENCE_CREATE_SPACE

Creates a space as specified in the payload. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to create spaces.

Action Parameters

alias

string

description__representation

string

description__value

string

key

string

name

stringRequired

roleAssignments__principal__principalId

string

roleAssignments__principal__principalType

string

roleAssignments__roleId

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete page

SLUG: CONFLUENCE_DELETE_PAGE

Delete a page by id. by default this will delete pages that are non-drafts. to delete a page that is a draft, the endpoint must be called on a draft with the following param `draft=true`. discarded drafts are not sent to the trash and are permanently deleted. deleting a page moves the page to the trash, where it can be restored later. to permanently delete a page (or "purge" it), the endpoint must be called on a **trashed** page with the following param `purge=true`. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space. permission to delete pages in the space. permission to administer the space (if attempting to purge).

Action Parameters

draft

boolean

integerRequired

purge

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get child pages

SLUG: CONFLUENCE_GET_CHILD_PAGES

Returns all child pages for given page id. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). only pages that the user has permission to view will be returned.

Action Parameters

cursor

string

integerRequired

limit

integerDefaults to 25

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get labels

SLUG: CONFLUENCE_GET_LABELS

Returns all labels. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). only labels that the user has permission to view will be returned.

Action Parameters

cursor

string

label__id

array

limit

integerDefaults to 25

prefix

array

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get page by id

SLUG: CONFLUENCE_GET_PAGE_BY_ID

Returns a specific page. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space.

Action Parameters

body__format

string

get__draft

boolean

integerRequired

include__collaborators

boolean

include__favorited__by__current__user__status

boolean

include__labels

boolean

include__likes

boolean

include__operations

boolean

include__properties

boolean

include__version

booleanDefaults to True

include__versions

boolean

include__webresources

boolean

status

array

version

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get spaces

SLUG: CONFLUENCE_GET_SPACES

Returns all spaces. the results will be sorted by id ascending. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). only spaces that the user has permission to view will be returned.

Action Parameters

cursor

string

description__format

string

favorited__by

string

ids

array

include__icon

boolean

keys

array

labels

array

limit

integerDefaults to 25

not__favorited__by

string

sort

string

status

string

type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update page

SLUG: CONFLUENCE_UPDATE_PAGE

Update a page by id. when the "current" version is updated, the provided body content is considered as the latest version. this latest body content will be attempted to be merged into the draft version through a content reconciliation algorithm. if two versions are significantly diverged, the latest provided content may entirely override what was previously in the draft. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the page and its corresponding space. permission to update pages in the space.

Action Parameters

body

objectRequired

stringRequired

ownerId

parentId

spaceId

status

stringRequired

title

stringRequired

version__message

string

version__number

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update content property for Smart-link in the content tree by ID

SLUG: CONFLUENCE_UPDATE_SMART_LINK_PROPERTY

Update content property for the content id in the atlas content tree

Action Parameters

embed__id

integerRequired

key

string

property__id

integerRequired

value

version__message

string

version__number

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Check site access for a list of emails

SLUG: CONFLUENCE_CHECK_SITE_ACCESS_FOR_A_LIST_OF_EMAILS

Returns the list of emails from the input list that do not have access to site. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission).

Action Parameters

emails

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Convert content ids to content types

SLUG: CONFLUENCE_CONVERT_CONTENT_IDS_TO_CONTENT_TYPES

Converts a list of content ids into their associated content types. this is useful for users migrating from v1 to v2 who may have stored just content ids without their associated type. this will return types as they should be used in v2. notably, this will return `inline-comment` for inline comments and `footer-comment` for footer comments, which is distinct from them both being represented by `comment` in v1. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to view the requested content. any content that the user does not have permission to view or does not exist will map to `null` in the response.

Action Parameters

contentIds

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create bulk user lookup using ids

SLUG: CONFLUENCE_CREATE_BULK_USER_LOOKUP_USING_IDS

Returns user details for the ids provided in the request body. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to access the confluence site ('can use' global permission). the user must be able to view user profiles in the confluence site.

Action Parameters

accountIds

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create content property for attachment

SLUG: CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_ATTACHMENT

Creates a new content property for an attachment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the attachment.

Action Parameters

attachment__id

stringRequired

key

string

value

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create content property for blog post

SLUG: CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_BLOG_POST

Creates a new property for a blogpost. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the blog post.

Action Parameters

blogpost__id

integerRequired

key

string

value

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create content property for comment

SLUG: CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_COMMENT

Creates a new content property for a comment. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the comment.

Action Parameters

comment__id

integerRequired

key

string

value

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create content property for custom content

SLUG: CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_CUSTOM_CONTENT

Creates a new content property for a piece of custom content. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the custom content.

Action Parameters

custom__content__id

integerRequired

key

string

value

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create content property for database

SLUG: CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_DATABASE

Creates a new content property for a database. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the database.

Action Parameters

integerRequired

key

string

value

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create content property for folder

SLUG: CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_FOLDER

Creates a new content property for a folder. **[permissions](https://confluence.atlassian.com/x/ aozkw) required**: permission to update the folder.

Action Parameters

integerRequired

key

string

value

Action Response

data

objectRequired

error

string

successful

booleanRequired