Confluence

Learn how to use Confluence with Composio

Overview

SLUG: CONFLUENCE

Description

A tool for team collaboration and knowledge management.

Authentication Details

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

Connecting to Confluence

Create an auth config

Use the dashboard to create an auth config for the Confluence toolkit. This allows you to connect multiple Confluence accounts to Composio for agents to use.

1

Select App

Navigate to Confluence.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Confluence Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4confluence_auth_config_id = "ac_YOUR_CONFLUENCE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Confluence: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, confluence_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Confluence toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CONFLUENCE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Content Label

Description

Tool to add labels to a piece of content. use after obtaining the content id to tag pages or blog posts with metadata labels.

Action Parameters

id
stringRequired
labels
arrayRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Space by ID

Description

Tool to retrieve a confluence space by its id. use when you need detailed metadata of a specific space.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Blogpost

Description

Tool to create a new confluence blog post. use when you need to publish content in a specific space.

Action Parameters

body
objectRequired
labels
array
metadata
object
parentId
string
spaceId
stringRequired
status
stringRequired
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Page

Description

Tool to create a new confluence page in a specified space. use when you need to create new documentation or content.

Action Parameters

body
objectRequired
parentId
string
spaceId
stringRequired
title
stringRequired
type
stringDefaults to page

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Page Property

Description

Tool to create a property on a confluence page. use when you need to add custom metadata or settings to a page.

Action Parameters

key
stringRequired
page_id
stringRequired
value
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Private Space

Description

Tool to create a private confluence space. use when you need an isolated workspace viewable only by its creator.

Action Parameters

description
object
key
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Space

Description

Tool to create a new confluence space. use when setting up a new knowledge area for organization.

Action Parameters

description
object
key
stringRequired
metadata
object
name
stringRequired
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Page

Description

Tool to delete a confluence page. use with caution as this will permanently remove the page from the space.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Attachments

Description

Tool to retrieve attachments of a confluence page. use after confirming page id to list its attachments (supports pagination).

Action Parameters

limit
integerDefaults to 25
mediaType
string
pageId
stringRequired
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Attachment Labels

Description

Tool to list labels on an attachment. use after confirming the attachment id to fetch its labels.

Action Parameters

id
stringRequired
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Audit Logs

Description

Tool to retrieve confluence audit records. use when you need to fetch and filter audit logs for compliance or troubleshooting.

Action Parameters

from_
string
limit
integer
searchString
string
start
integer
to
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogposts

Description

Tool to retrieve a list of blog posts. use when you need blog post ids.

Action Parameters

cursor
string
limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogpost by ID

Description

Tool to retrieve a specific confluence blog post by its id. use when you have a blog post id and need detailed metadata and content.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogpost Labels

Description

Tool to retrieve labels of a specific confluence blog post by id. use after obtaining the blog post id to list its labels.

Action Parameters

id
stringRequired
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogpost Like Count

Description

Tool to get like count for a confluence blog post. use after confirming the blog post id to retrieve total likes.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogpost Versions

Description

Tool to retrieve all versions of a specific blog post. use when you have a blogpostid and need to list version numbers.

Action Parameters

blogpostId
stringRequired
cursor
string
limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogpost Version Details

Description

Tool to retrieve details for a specific version of a blog post. use when you have a blogpostid and versionnumber and need detailed metadata for that version.

Action Parameters

blogpostId
stringRequired
versionNumber
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blog Posts

Description

Tool to retrieve a list of blog posts. use when you need a paginated list of confluence blog posts.

Action Parameters

cursor
string
limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blog Posts For Label

Description

Tool to list all blog posts under a specific label. use when you have a label id and need to retrieve associated blog posts.

Action Parameters

cursor
string
id
stringRequired
limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Child Pages

Description

Tool to list all direct child pages of a given confluence page. use when you have a parent page id and need to discover its direct descendants.

Action Parameters

id
stringRequired
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Labels

Description

Tool to retrieve all labels in a confluence site. use when you need to list or page through labels.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Page Labels

Description

Tool to retrieve labels of a specific confluence page by id. use after obtaining the page id to list its labels.

Action Parameters

id
stringRequired
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Labels for Space

Description

Tool to list labels on a space. use when you need to retrieve labels for a specific space.

Action Parameters

id
stringRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Labels for Space Content

Description

Tool to list labels on all content in a space. use when you need to retrieve or filter content labels by space, with pagination and optional prefix filtering.

Action Parameters

id
stringRequired
limit
integer
prefix
string
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Pages

Description

Tool to retrieve a list of pages. use when you need a paginated list of confluence pages.

Action Parameters

authorId
string
direction
string
expand
array
label
array
limit
integerDefaults to 25
sort
string
spaceId
string
start
integer
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Page by ID

Description

Tool to retrieve a confluence page by its id. use when you have a page id and need its detailed metadata and content.

Action Parameters

draft
boolean
id
stringRequired
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Page Like Count

Description

Tool to get like count for a confluence page. use after confirming the page id to retrieve total likes.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Page Versions

Description

Tool to retrieve all versions of a specific confluence page. use after confirming the page id to audit its edit history.

Action Parameters

id
stringRequired
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Spaces

Description

Tool to retrieve a list of confluence spaces. use when you need a paginated list of spaces with optional filtering.

Action Parameters

expand
array
label
array
limit
integerDefaults to 25
spaceKey
array
start
integer
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Space by ID

Description

Tool to retrieve a confluence space by its id. use when you need detailed metadata of a specific space.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Space Contents

Description

Tool to retrieve content in a confluence space. use when you need to list pages, blogposts, or attachments of a specific space key.

Action Parameters

limit
integer
postingDay
string
spaceKey
stringRequired
start
integer
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Blogpost

Description

Tool to update a confluence blog post's title or content. use when you need to modify an existing blog post. ensure you have the latest version number before calling.

Action Parameters

body
objectRequired
id
stringRequired
spaceId
stringRequired
status
string
title
stringRequired
type
stringDefaults to blogpost
version
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Page

Description

Tool to update an existing confluence page. use when you need to modify existing documentation or content.

Action Parameters

body
objectRequired
id
stringRequired
spaceId
stringRequired
title
stringRequired
type
stringDefaults to page
version
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Blogpost Property

Description

Tool to create a property on a specified blog post. use when you need to add custom metadata to a blog post.

Action Parameters

id
stringRequired
key
stringRequired
value
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Whiteboard Property

Description

Tool to create a new content property on a whiteboard. use when you need to attach custom metadata to a confluence whiteboard.

Action Parameters

key
stringRequired
value
objectRequired
whiteboard_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Space Property

Description

Tool to create a new property on a confluence space. use after confirming the space id when adding custom metadata.

Action Parameters

key
stringRequired
spaceId
stringRequired
value
objectRequired
version
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Whiteboard

Description

Tool to create a new confluence whiteboard. use when you need to start a collaborative whiteboard session.

Action Parameters

parentId
string
spaceId
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Blogpost Property

Description

Tool to delete a blog post property. use when you need to remove custom metadata from a specified blog post.

Action Parameters

id
stringRequired
propertyKey
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Page Content Property

Description

Tool to delete a content property from a page by property id. use when you need to remove custom metadata from a page for cleanup or auditing.

Action Parameters

pageId
stringRequired
propertyId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Whiteboard Content Property

Description

Tool to delete a content property from a whiteboard by property id. use when you need to remove custom metadata from a whiteboard.

Action Parameters

propertyId
stringRequired
whiteboardId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Space

Description

Tool to delete a confluence space by its key. use when you need to permanently remove a space.

Action Parameters

space_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Space Property

Description

Tool to delete a space property. use when you need to remove a property from a confluence space after review.

Action Parameters

propertyKey
stringRequired
spaceIdOrKey
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blogpost Operations

Description

Tool to retrieve permitted operations for a confluence blog post. use after confirming the blog post id to see allowed actions.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Blog Post Content Properties

Description

Tool to retrieve all content properties on a blog post. use when you need to list metadata properties set on a specific confluence blog post.

Action Parameters

blogpost_id
stringRequired
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Page Content Properties

Description

Tool to retrieve all content properties on a page. use when you need to list metadata properties set on a specific confluence page.

Action Parameters

cursor
string
limit
integer
page_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Content Restrictions

Description

Tool to retrieve restrictions on a confluence content item. use when you need to see who can view or edit a page or blog post.

Action Parameters

expand
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User

Description

Tool to get information about the currently authenticated user. use when you need to check user details or permissions.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Inline Comments for Blog Post

Description

Tool to retrieve inline comments for a confluence blog post. use when you need inline comment details by blog post id.

Action Parameters

expand
string
id
stringRequired
limit
integerDefaults to 25
location
string
parentVersion
integer
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Page Ancestors

Description

Tool to retrieve all ancestors for a given confluence page by its id. use when you need the full page hierarchy.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Space Properties

Description

Tool to get properties of a confluence space. use when you need to retrieve custom metadata or settings stored as space properties.

Action Parameters

id
stringRequired
key
array
limit
integerDefaults to 25
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Anonymous User

Description

Tool to retrieve information about the anonymous user. use when you need to obtain guest user details before unauthenticated interactions.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Content

Description

Searches for content by filtering pages from the confluence v2 api with intelligent ranking. since the native search endpoint is deprecated, this action: 1. fetches pages from the v2 pages endpoint with pagination (up to 300 pages) 2. applies intelligent client-side filtering with relevance scoring 3. returns results ranked by match quality (exact phrase > all words > partial matches) the search algorithm prioritizes exact phrase matches, then checks for all query words present in the title, and finally considers partial word matches. results are automatically sorted by relevance score for optimal user experience.

Action Parameters

expand
string
limit
integerDefaults to 25
query
stringRequired
spaceKey
string
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Users

Description

Searches for users using user-specific queries from the confluence query language (cql).

Action Parameters

accountId
string
cursor
string
limit
integerDefaults to 25

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Blogpost Property

Description

Tool to update a property of a specified blog post. use when you need to modify custom metadata on a blog post.

Action Parameters

id
stringRequired
propertyKey
stringRequired
value
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Page Content Property

Description

Tool to update a content property on a confluence page. use when you need to modify an existing metadata property by its id.

Action Parameters

pageId
stringRequired
propertyId
stringRequired
value
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Whiteboard Content Property

Description

Tool to update a content property on a whiteboard. use when you need to modify metadata on a confluence whiteboard.

Action Parameters

propertyId
stringRequired
value
objectRequired
whiteboardId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Space Property

Description

Tool to update a space property. use when you need to modify custom metadata stored on a confluence space (requires fetching the current property version first).

Action Parameters

propertyKey
stringRequired
spaceKey
stringRequired
value
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired