Confluence

The Arcade Confluence toolkit provides a pre-built set of tools for interacting with Confluence. These tools make it easy to build agents and AI apps that can:

• Work with pages, spaces, and attachments
• Search for content

Available tools

These tools are currently available in the Arcade Confluence toolkit.

CreatePage

Create a new page at the root of the given space.

Parameters

• space_identifier (string, required): The ID or title of the space to create the page in
• title (string, required): The title of the page
• content (string, required): The content of the page. Only plain text is supported
• parent_id (string, optional): The ID of the parent. If not provided, the page will be created at the root of the space
• is_private (bool, optional): If true, then only the user who creates this page will be able to see it. Defaults to False
• is_draft (bool, optional): If true, then the page will be created as a draft. Defaults to False

UpdatePageContent

Update a page’s content.

Parameters

• page_identifier (string, required): The ID or title of the page to update. Numerical titles are NOT supported
• content (string, required): The content of the page. Only plain text is supported
• update_mode (enum (PageUpdateMode), optional): The mode of update. Defaults to ‘append’

RenamePage

Rename a page by changing its title.

Parameters

• page_identifier (string, required): The ID or title of the page to rename. Numerical titles are NOT supported
• title (string, required): The title of the page

GetPage

Retrieve a SINGLE page’s content by its ID or title.

If a title is provided, then the first page with an exact matching title will be returned.

IMPORTANT: For retrieving MULTIPLE pages, use get_pages_by_id instead for a massive performance and efficiency boost. If you call this function multiple times instead of using get_pages_by_id, then the universe will explode.

Parameters

• page_identifier (string, required): Can be a page’s ID or title. Numerical titles are NOT supported

GetPagesById

Get the content of MULTIPLE pages by their ID in a single efficient request.

IMPORTANT: Always use this function when you need to retrieve content from more than one page, rather than making multiple separate calls to get_page, because this function is significantly more efficient than calling get_page multiple times.

Parameters

• page_ids (list of strings, required): The IDs of the pages to get. IDs are numeric. Titles of pages are NOT supported. Maximum of 250 page ids supported

ListPages

Get the content of multiple pages by their ID.

Parameters

• space_ids (list of strings, optional): Restrict the response to only include pages in these spaces. Only space IDs are supported. Titles of spaces are NOT supported. If not provided, then no restriction is applied. Maximum of 100 space ids supported
• sort_by (enum (PageSortOrder), optional): The order of the pages to sort by. Defaults to created-date-newest-to-oldest
• limit (int, optional): The maximum number of pages to return. Defaults to 25. Max is 250
• pagination_token (string, optional): The pagination token to use for the next page of results

ListAttachments

List attachments in a workspace.

Parameters

• sort_order (enum (AttachmentSortOrder), optional): The order of the attachments to sort by. Defaults to created-date-newest-to-oldest
• limit (int, optional): The maximum number of attachments to return. Defaults to 25. Max is 250
• pagination_token (string, optional): The pagination token to use for the next page of results

GetAttachmentsForPage

Get attachments for a page by its ID or title.

If a page title is provided, then the first page with an exact matching title will be returned.

Parameters

• page_identifier (string, required): The ID or title of the page to get attachments for
• limit (int, optional): The maximum number of attachments to return. Defaults to 25. Max is 250
• pagination_token (string, optional): The pagination token to use for the next page of results

SearchContent

Search for content in Confluence.

The search is performed across all content in the authenticated user’s Confluence workspace. All search terms in Confluence are case insensitive.

You can use the parameters in different ways:

• must_contain_all: For AND logic - content must contain ALL of these
• can_contain_any: For OR logic - content can contain ANY of these
• Combine them: must_contain_all=[‘banana’] AND can_contain_any=[‘database’, ‘guide’]

Parameters

• must_contain_all (list of strings, optional): Words/phrases that content MUST contain (AND logic). Each item can be:
  • Single word: ‘banana’ - content must contain this word
  • Multi-word phrase: ‘How to’ - content must contain all these words (in any order)
  • All items in this list must be present for content to match
  • Example: [‘banana’, ‘apple’] finds content containing BOTH ‘banana’ AND ‘apple’
• can_contain_any (list of strings, optional): Words/phrases where content can contain ANY of these (OR logic). Each item can be:
  • Single word: ‘project’ - content containing this word will match
  • Multi-word phrase: ‘pen & paper’ - content containing all these words will match
  • Content matching ANY item in this list will be included
  • Example: [‘project’, ‘documentation’] finds content with ‘project’ OR ‘documentation’
• enable_fuzzy (bool, optional): Enable fuzzy matching to find similar terms (e.g. ‘roam’ will find ‘foam’). Defaults to True
• limit (int, optional): Maximum number of results to return (1-100). Defaults to 25

GetSpace

Get the details of a space by its ID or key.

Parameters

• space_identifier (string, required): Can be a space’s ID or key. Numerical keys are NOT supported

ListSpaces

List all spaces sorted by name in ascending order.

Parameters

• limit (int, optional): The maximum number of spaces to return. Defaults to 25. Max is 250
• pagination_token (string, optional): The pagination token to use for the next page of results

GetSpaceHierarchy

Retrieve the full hierarchical structure of a Confluence space as a tree structure.

Only structural metadata is returned (not content). The response is akin to the sidebar in the Confluence UI.

Includes all pages, folders, whiteboards, databases, smart links, etc. organized by parent-child relationships.

Parameters

• space_identifier (string, required): Can be a space’s ID or key. Numerical keys are NOT supported

Auth

The Arcade Notion toolkit uses the Notion auth provider to connect to users’ Notion accounts.

With the hosted Arcade Engine, there’s nothing to configure. Your users will see Arcade as the name of the application that’s requesting permission.

With a self-hosted installation of Arcade, you need to configure the Notion auth provider with your own Notion app credentials.

Reference

PageUpdateMode

The mode of update.

• prepend (string: “prepend”)
• append (string: “append”)
• replace (string: “replace”)

PageSortOrder

The order of the pages to sort by.

• id-ascending: Sort by ID in ascending order.
• id-descending: Sort by ID in descending order.
• title-ascending: Sort by title in ascending order.
• title-descending: Sort by title in descending order.
• created-date-oldest-to-newest: Sort by created date from oldest to newest.
• created-date-newest-to-oldest: Sort by created date from newest to oldest.
• modified-date-oldest-to-newest: Sort by modified date from oldest to newest.
• modified-date-newest-to-oldest: Sort by modified date from newest to oldest.

AttachmentSortOrder

The order of the attachments to sort by.

• created-date-oldest-to-newest: Sort by created date from oldest to newest.
• created-date-newest-to-oldest: Sort by created date from newest to oldest.
• modified-date-oldest-to-newest: Sort by modified date from oldest to newest.
• modified-date-newest-to-oldest: Sort by modified date from newest to oldest.

pip install arcade_confluence