> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Confluence > A tool for team collaboration and knowledge management A tool for team collaboration and knowledge management. `confluence` · **69 tools** · **23 triggers** ## Connect it ```bash theme={"theme":"github-dark"} run auth confluence run auth confluence --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run confluence # common commands run confluence --all # every command ``` ```ts theme={"theme":"github-dark"} import { confluence } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `add-content-label` | Tool to add labels to a piece of content. Use after obtaining the content ID to tag pages or blog posts with metadata labels. | | `create-blogpost` | Tool to create a new Confluence blog post. Use when you need to publish content in a specific space. | | `create-footer-comment` | Tool to create a footer comment on a Confluence page, blog post, attachment, or custom content. | | `create-inline-comment` | Creates an inline comment on a Confluence page or blog post, highlighting specific text. | | `create-page` | Tool to create a new Confluence page in a specified space. Use when you need to create new documentation or content. | | `create-page-property` | Tool to create a property on a Confluence page. Use when you need to add custom metadata or settings to a page. | | `create-private-space` | Tool to create a private Confluence space. Use when you need an isolated workspace viewable only by its creator. | | `create-space` | Tool to create a new Confluence space. Use when setting up a new knowledge area for organization. | | `delete-blogpost` | Deletes a Confluence blog post by ID. Use this action when you need to remove a blog post from a Confluence space. | | `delete-page` | Tool to delete a Confluence page. Use with caution as this permanently removes the page and its content with no recovery option. | | `download-attachment` | Downloads an attachment from a Confluence page and returns a downloadable file. | | `get-attachment-labels` | Tool to list labels on an attachment. Use after confirming the attachment ID to fetch its labels. | | `get-attachments` | Tool to retrieve attachments of a Confluence page. Use after confirming page ID to list its attachments (supports pagination). | | `get-audit-logs` | Tool to retrieve Confluence audit records. Use when you need to fetch and filter audit logs for compliance or troubleshooting. | | `get-blogpost-by-id` | 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. | | `get-blogpost-labels` | Tool to retrieve labels of a specific Confluence blog post by ID. | | `get-blogpost-like-count` | Tool to get like count for a Confluence blog post. Use after confirming the blog post ID to retrieve total likes. | | `get-blog-posts` | Tool to retrieve a list of blog posts. Use when you need a paginated list of Confluence blog posts. | | `get-blog-posts-for-label` | Tool to list all blog posts under a specific label. Use when you have a label ID and need to retrieve associated blog posts. | | `get-blogpost-version-details` | Tool to retrieve details for a specific version of a blog post. | | `get-blogpost-versions` | Tool to retrieve all versions of a specific blog post. Use when you have a blogpostId and need to list version numbers. | | `get-child-pages` | Tool to list all direct child pages of a given Confluence page. | | `get-labels` | Tool to retrieve all labels in a Confluence site; use for label discovery when you need to list or page through labels. | | `get-labels-for-page` | Tool to retrieve labels of a specific Confluence page by ID. | | `get-labels-for-space` | Tool to list labels on a space. Use when you need to retrieve labels for a specific space. | | Tool | What it does | | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-content-label` | Tool to add labels to a piece of content. Use after obtaining the content ID to tag pages or blog posts with metadata labels. | | `cql-search` | Searches for content in Confluence using Confluence Query Language (CQL). | | `create-blogpost` | Tool to create a new Confluence blog post. Use when you need to publish content in a specific space. | | `create-blogpost-property` | Tool to create a property on a specified blog post. Use when you need to add custom metadata to a blog post. | | `create-content-property-for-whiteboard` | Tool to create a new content property on a whiteboard. Use when you need to attach custom metadata to a Confluence whiteboard. | | `create-footer-comment` | Tool to create a footer comment on a Confluence page, blog post, attachment, or custom content. | | `create-inline-comment` | Creates an inline comment on a Confluence page or blog post, highlighting specific text. | | `create-page` | Tool to create a new Confluence page in a specified space. Use when you need to create new documentation or content. | | `create-page-property` | Tool to create a property on a Confluence page. Use when you need to add custom metadata or settings to a page. | | `create-private-space` | Tool to create a private Confluence space. Use when you need an isolated workspace viewable only by its creator. | | `create-space` | Tool to create a new Confluence space. Use when setting up a new knowledge area for organization. | | `create-space-property` | Tool to create a new property on a Confluence space. Use after confirming the space ID when adding custom metadata. | | `create-whiteboard` | Tool to create a new Confluence whiteboard. Use when you need to start a collaborative whiteboard session. | | `delete-blogpost` | Deletes a Confluence blog post by ID. Use this action when you need to remove a blog post from a Confluence space. | | `delete-blogpost-property` | Tool to delete a blog post property. Use when you need to remove custom metadata from a specified blog post. | | `delete-content-property-for-page-by-id` | Tool to delete a content property from a page by property ID. | | `delete-content-property-for-whiteboard-by-id` | Tool to delete a content property from a whiteboard by property ID. | | `delete-page` | Tool to delete a Confluence page. Use with caution as this permanently removes the page and its content with no recovery option. | | `delete-space` | Tool to delete a Confluence space by its key. Use when you need to permanently remove a space. | | `delete-space-property` | Tool to delete a space property. Use when you need to remove a property from a Confluence space after review. | | `download-attachment` | Downloads an attachment from a Confluence page and returns a downloadable file. | | `find-text-selections` | Finds text occurrences in a Confluence page's content to help with inline comment creation. | | `get-attachment-labels` | Tool to list labels on an attachment. Use after confirming the attachment ID to fetch its labels. | | `get-attachments` | Tool to retrieve attachments of a Confluence page. Use after confirming page ID to list its attachments (supports pagination). | | `get-audit-logs` | Tool to retrieve Confluence audit records. Use when you need to fetch and filter audit logs for compliance or troubleshooting. | | `get-blogpost-by-id` | 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. | | `get-blogpost-labels` | Tool to retrieve labels of a specific Confluence blog post by ID. | | `get-blogpost-like-count` | Tool to get like count for a Confluence blog post. Use after confirming the blog post ID to retrieve total likes. | | `get-blogpost-operations` | Tool to retrieve permitted operations for a Confluence blog post. | | `get-blog-posts` | Tool to retrieve a list of blog posts. Use when you need a paginated list of Confluence blog posts. | | `get-blog-posts-for-label` | Tool to list all blog posts under a specific label. Use when you have a label ID and need to retrieve associated blog posts. | | `get-blogpost-version-details` | Tool to retrieve details for a specific version of a blog post. | | `get-blogpost-versions` | Tool to retrieve all versions of a specific blog post. Use when you have a blogpostId and need to list version numbers. | | `get-child-pages` | Tool to list all direct child pages of a given Confluence page. | | `get-content-properties-for-blog-post` | 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. | | `get-content-properties-for-page` | Tool to retrieve all content properties on a page. Use when you need to list metadata properties set on a specific Confluence page. | | `get-content-restrictions` | 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. | | `get-current-user` | Tool to get information about the currently authenticated user - always scoped to the account tied to the configured connection, not arbitrary users. | | `get-inline-comments-for-blog-post` | Tool to retrieve inline comments for a Confluence blog post. | | `get-labels` | Tool to retrieve all labels in a Confluence site; use for label discovery when you need to list or page through labels. | | `get-labels-for-page` | Tool to retrieve labels of a specific Confluence page by ID. | | `get-labels-for-space` | Tool to list labels on a space. Use when you need to retrieve labels for a specific space. | | `get-labels-for-space-content` | 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. | | `get-page-ancestors` | Tool to retrieve all ancestors for a given Confluence page by its ID. | | `get-page-by-id` | Tool to retrieve a Confluence page by its ID. Use when you have a page ID and need its detailed metadata and content. | | `get-page-footer-comments` | Tool to retrieve footer (non-inline) comments for a Confluence page. | | `get-page-inline-comments` | Tool to retrieve inline comments for a Confluence page. Use when you need inline comment details by page ID. | | `get-page-like-count` | Tool to get like count for a Confluence page. Use after confirming the page ID to retrieve total likes. | | `get-pages` | Tool to retrieve a paginated list of Confluence pages. Results are permission-scoped to the authenticated user; empty results may reflect access restrictions. | | `get-page-versions` | Tool to retrieve all versions of a specific Confluence page. | | `get-space-by-id` | Tool to retrieve a Confluence space by its ID. Use when you need detailed metadata of a specific space. | | `get-space-contents` | Tool to retrieve content in a Confluence space. Use when you need to list pages or blogposts of a specific space key. | | `get-space-properties` | Tool to get properties of a Confluence space. Use when you need to retrieve custom metadata or settings stored as space properties. | | `get-spaces` | Tool to retrieve a paginated list of Confluence spaces with optional filtering. | | `get-tasks` | Tool to list Confluence tasks (action items) with filtering by assignee, creator, space, page, blog post, status, and dates. | | `get-user-anonymous` | Tool to retrieve information about the anonymous user. Use when you need to obtain guest user details before unauthenticated interactions. | | `list-spaces` | Retrieves a paginated list of Confluence spaces visible to the authenticated user. | | `search-content` | Searches for content by filtering pages from the Confluence v2 API with intelligent ranking. | | `search-pages` | Searches for pages in Confluence using filters like title, space, and status. | | `search-spaces` | Searches for Confluence spaces with flexible filtering by name, key, type, status, and labels. | | `search-users` | Searches for users using user-specific queries from the Confluence Query Language (CQL). | | `update-blogpost` | Tool to update a Confluence blog post's title or content. Use when you need to modify an existing blog post. | | `update-blogpost-property` | Tool to update a property of a specified blog post. Use when you need to modify custom metadata on a blog post. | | `update-content-property-for-page-by-id` | Tool to update a content property on a Confluence page. Use when you need to modify an existing metadata property by its ID. | | `update-content-property-for-whiteboard-by-id` | Tool to update a content property on a whiteboard. Use when you need to modify metadata on a Confluence whiteboard. | | `update-page` | Tool to update an existing Confluence page, replacing the entire page content. | | `update-space-property` | 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). | | `update-task` | Tool to update a Confluence task status. Use when you need to mark tasks as complete or incomplete in workflows or dashboards. | | `validate-credential` | Validates Confluence credentials by attempting to retrieve the current authenticated user's information. | ## Triggers (23) Subscribe with `.on(...)` in a script. A trigger with required configuration takes it as the second argument. | Trigger | Needs | What fires it | | -------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------- | | New Attachment Added | `pageId` | Triggers when a new attachment is uploaded to a Confluence page. | | Blog Post Added to Label | `label_id` | Triggers when a new blog post is added to a specific label in Confluence. | | Blogpost Inline Comment Added | `blog_post_id` | Triggers when a new inline comment is added to a Confluence blog post. | | Blog Post Like Count Changed | `blogpost_id` | Triggers when a Confluence blog post's like count changes (someone likes or unlikes). | | Blog Post Updated | `blogpost_id` | Triggers when a Confluence blog post is updated (any edit that creates a new version). | | Content Restrictions Changed | `content_id` | Triggers when view or edit restrictions change on a Confluence page or blog post. | | New Footer Comment Added to Page | `page_id` | Triggers when a new footer comment is added to a Confluence page. | | New Audit Log Record | nothing | Triggers when a new audit log record is created in Confluence. | | New Blog Post Created | nothing | Triggers when a new blog post is created in Confluence. | | New Child Page Created | `parent_page_id` | Triggers when a new child page is created under a specific parent page in Confluence. | | New CQL Content Match | `cql_query` | Triggers when new Confluence content appears that matches a user-provided CQL query. | | New Task Created | nothing | Triggers when a new task (action item) is created in Confluence. | | Page Content Properties Changed | `page_id` | Triggers when content properties on a Confluence page are added, removed, or updated. | | New Page Created | nothing | Triggers when a new page is created in Confluence. | | New Inline Comment Added to Page | `page_id` | Triggers when a new inline comment is added to a Confluence page. | | Page Like Count Changed | `page_id` | Triggers when a Confluence page's like count changes (someone likes or unlikes). | | Page Moved | `page_id` | Triggers when a Confluence page is moved to a different location in the page hierarchy. | | Page Updated | `page_id` | Triggers when a Confluence page is updated (any edit that creates a new version). | | Page Version Created | `page_id` | Triggers when a new version is created for a specific Confluence page. | | New Space Content Added | nothing | Triggers when new content (pages or blog posts) is added to a Confluence space. | | New Space Created | nothing | Triggers when a new Confluence space is created. | | Space Details Changed | `space_id` | Triggers when a Confluence space's details change (name, description, status, owner, icon, etc.). | | Space Properties Changed | `space_id` | Triggers when properties on a Confluence space are added, removed, or updated. | [Open Confluence in the console →](https://app.boxd.sh/integrations/detail/confluence)