> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Confluence

> Reference for the Tracecat Confluence integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Add comment

Action ID: `tools.confluence.add_page_comment`

Add a comment to a Confluence page.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/\{id}/child-commentsOfContent](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/\{id}/child-commentsOfContent)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="content" type="string" required>
  Comment content in Confluence storage (XHTML) or wiki markup. Convert Markdown to storage before sending if needed.
</ParamField>

<ParamField path="page_id" type="string" required>
  The ID of the page to comment on.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="content_representation" type="string">
  Content representation for the comment body (storage or wiki).

  Default: `"storage"`.
</ParamField>

## Add page label

Action ID: `tools.confluence.add_page_label`

Add a label to a Confluence page.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#label-addLabelsToContent](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#label-addLabelsToContent)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="name" type="string" required>
  Label name to apply.
</ParamField>

<ParamField path="page_id" type="string" required>
  The ID of the page to label.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="prefix" type="string">
  Label prefix (global, my, or team).

  Default: `"global"`.
</ParamField>

## Create page

Action ID: `tools.confluence.create_page`

Create a new Confluence page in a space, optionally under a parent.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-createContent](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-createContent)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="content" type="string" required>
  Page body in Confluence storage (XHTML) or wiki markup. Convert Markdown to storage before sending if needed.
</ParamField>

<ParamField path="space_key" type="string" required>
  Space key for the page (e.g., DEV, TEAM).
</ParamField>

<ParamField path="title" type="string" required>
  Title of the new page.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="content_representation" type="string">
  Content representation for the body (storage or wiki).

  Default: `"storage"`.
</ParamField>

<ParamField path="parent_id" type="string | null">
  Optional parent page ID to nest under.

  Default: `null`.
</ParamField>

## Delete page

Action ID: `tools.confluence.delete_page`

Delete a Confluence page by ID.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-delete](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-delete)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="page_id" type="string" required>
  The ID of the page to delete.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

## Get child pages

Action ID: `tools.confluence.get_page_children`

List child pages for a parent Confluence page with pagination and optional content expansion.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/\{id}/child-childrenOfType](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/\{id}/child-childrenOfType)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="parent_id" type="string" required>
  The ID of the parent page whose children you want to retrieve.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="expand" type="string">
  Fields to expand on each child (e.g., version, body.storage, body.view).

  Default: `"version"`.
</ParamField>

<ParamField path="include_content" type="boolean">
  Whether to force body.storage expansion for child content.

  Default: `false`.
</ParamField>

<ParamField path="limit" type="integer">
  Maximum number of child pages to return (1-50).

  Default: `25`.
</ParamField>

<ParamField path="start" type="integer">
  Starting index for pagination (0-based).

  Default: `0`.
</ParamField>

## Get page by ID

Action ID: `tools.confluence.get_page`

Retrieve a Confluence page by its numeric ID with optional expanded fields.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-getContentById](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-getContentById)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="page_id" type="string" required>
  Confluence page ID (numeric). In URLs like [https://example.atlassian.net/wiki/spaces/TEAM/pages/123456789/Page+Title](https://example.atlassian.net/wiki/spaces/TEAM/pages/123456789/Page+Title) the ID is 123456789.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="expand" type="string">
  Comma-separated fields to expand (e.g., body.storage, body.view, version, space, ancestors, children.attachment).

  Default: `"body.storage,version,space"`.
</ParamField>

## Get page by title

Action ID: `tools.confluence.get_page_by_title`

Find a Confluence page by title within a space.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-getContent](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-getContent)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="space_key" type="string" required>
  Space key containing the page (e.g., DEV, TEAM).
</ParamField>

<ParamField path="title" type="string" required>
  Exact page title to retrieve.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="expand" type="string">
  Comma-separated fields to expand (e.g., body.storage, body.view, version, space, ancestors, children.attachment).

  Default: `"body.storage,version,space"`.
</ParamField>

## Get page comments

Action ID: `tools.confluence.get_page_comments`

Retrieve comments for a Confluence page with pagination support. Use start/limit to iterate through all comments.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/\{id}/child-commentsOfContent](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content/\{id}/child-commentsOfContent)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="page_id" type="string" required>
  Confluence page ID to fetch comments for.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="depth" type="string">
  Depth of comments to return (e.g., all, root).

  Default: `"all"`.
</ParamField>

<ParamField path="expand" type="string">
  Fields to expand on each comment (e.g., body.view, body.storage, version).

  Default: `"body.view,version"`.
</ParamField>

<ParamField path="limit" type="integer">
  Maximum number of comments to return per request (1-50).

  Default: `25`.
</ParamField>

<ParamField path="start" type="integer">
  Starting index for pagination (0-based). Use \_links.next from response to get next page.

  Default: `0`.
</ParamField>

## Get page labels

Action ID: `tools.confluence.get_page_labels`

List labels applied to a Confluence page.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#label-getLabelsForContent](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#label-getLabelsForContent)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="page_id" type="string" required>
  The ID of the page to fetch labels for.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

## Search content

Action ID: `tools.confluence.search_content`

Search Confluence content with Confluence Query Language (CQL) and optional space filters.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#search-search](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#search-search)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="query" type="string" required>
  Search query in CQL. Examples: 'type=page AND space=DEV', 'title\~"Runbook"', or 'text \~ "incident response"'. CQL supports operators like AND/OR, ranges, and exact matches.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="limit" type="integer">
  Maximum number of results to return (1-50).

  Default: `10`.
</ParamField>

<ParamField path="spaces_filter" type="string | null">
  Optional comma-separated space keys to filter results (adds OR space clauses to the query).

  Default: `null`.
</ParamField>

## Update page

Action ID: `tools.confluence.update_page`

Update an existing Confluence page, incrementing the version automatically.

Reference: [https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-update](https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#content-update)

### Secrets

Required secrets:

* `confluence`: required values `CONFLUENCE_USERNAME`, `CONFLUENCE_API_TOKEN`.

### Input fields

<ParamField path="content" type="string" required>
  Updated page body in Confluence storage (XHTML) or wiki markup. Convert Markdown to storage before sending if needed.
</ParamField>

<ParamField path="page_id" type="string" required>
  ID of the page to update.
</ParamField>

<ParamField path="title" type="string" required>
  New title for the page.
</ParamField>

<ParamField path="base_url" type="string | null">
  Confluence site base URL (e.g., [https://example.atlassian.net/wiki](https://example.atlassian.net/wiki)). Do not append /rest/api.

  Default: `null`.
</ParamField>

<ParamField path="content_representation" type="string">
  Content representation for the body (storage or wiki).

  Default: `"storage"`.
</ParamField>

<ParamField path="is_minor_edit" type="boolean">
  Whether this is a minor edit for versioning purposes.

  Default: `false`.
</ParamField>

<ParamField path="parent_id" type="string | null">
  Optional new parent page ID to set on update.

  Default: `null`.
</ParamField>

<ParamField path="version_comment" type="string">
  Optional version comment to record with the update.

  Default: `""`.
</ParamField>