Skip to main content

Confluence Component

Confluence is an open and shared workspace platform provided by Atlassian. Use the Confluence component to manage spaces, pages, and content properties.

Component key: confluence

Changelog ↓

Description

Confluence is an open and shared workspace platform provided by Atlassian. Use the Confluence component to manage spaces, pages, and content properties.

Connections

Confluence Basic

key: basic

Basic Authentication can be used to connect to both Confluence Cloud and self-hosted Confluence instances.

  • For Confluence Cloud: Use the account email and an API token
  • For Self-hosted Confluence: Use the account email and password
API Token vs Password

For Confluence Cloud, API tokens are required. Passwords are only accepted for self-hosted instances.

Prerequisites

Setup Steps

To generate an API token for Confluence Cloud:

  1. Log in to Atlassian API Token Management
  2. Select Create API token
  3. Enter a descriptive Label for the token and select Create
  4. Select Copy to clipboard to copy the generated token

For additional information on generating an API token, refer to the Atlassian documentation.

Configure the Connection

Add a Confluence action to the integration to automatically create a connection configuration variable.

Configure the Basic Auth connection:

  • Email: Enter the email address associated with the Confluence account (e.g., example.user@confluence.com)
  • API Token: Enter the API token generated from the Atlassian account management page, or for self-hosted instances, enter the account password
  • Host: Enter the Confluence site URL (e.g., your-domain.atlassian.net for Cloud or the server hostname for self-hosted instances)
Self-Hosted Credentials

For self-hosted Confluence instances, API tokens may not be available. Use the account password instead.

InputNotesExample
API Token

Your Confluence API token for authentication. Generate this from your Atlassian account settings.

ATATT3xFfGF0X1234567890abcdefghij
Email

Your Confluence account email address used for authentication.

john.doe@example.com
Host

Your Confluence site URL. Only enter your domain without the protocol.

your-domain.atlassian.net

Confluence OAuth 2.0

key: oauth2

To connect to Confluence using OAuth 2.0, create an OAuth 2.0 integration in the Atlassian Developer Console and configure the appropriate scopes.

For more information on developing Confluence applications, refer to the Confluence Security Overview.

Prerequisites

  • An Atlassian account with access to the Developer Console
  • Admin access to the Confluence site to be connected

Setup Steps

  1. Navigate to the Atlassian Developer Console and select Create to create a new OAuth 2.0 (3LO) integration
  2. Provide a name for the integration
  3. Under the Settings tab, locate the Client ID and Client Secret values - copy these for later use
  4. Navigate to the Authorization section and select Configure under OAuth 2.0 (3LO)
  5. Add https://oauth2.prismatic.io/callback as the Callback URL
  6. Navigate to the Permissions section and configure the required scopes:
    • Select the Confluence API tab
    • Choose either Classic scopes or Granular scopes based on requirements
    • Add the necessary scopes for the actions to be used (see scope recommendations below)
  7. Save the integration configuration

Configure the Connection

Add a Confluence action to the integration to automatically create a connection configuration variable.

Configure the OAuth 2.0 connection:

  • Enter the Client ID and Client Secret obtained from the Atlassian Developer Console
  • For Scopes, enter the space-separated list of scopes. The default scopes (Granular) provide access to most Confluence actions:
    offline_access delete:attachment:confluence read:attachment:confluence write:attachment:confluence read:custom-content:confluence write:custom-content:confluence delete:custom-content:confluence read:page:confluence write:page:confluence delete:page:confluence read:space:confluence
  • Refer to the Confluence Scopes Documentation for additional scope information
  • (Optional) If connecting to a specific Confluence site when multiple sites are available, enter the site name or full URL in API Site Override (e.g., example or https://example.atlassian.net)
Scope Consistency

Ensure the scopes configured in the connection match the scopes granted in the Atlassian Developer Console. Mismatched scopes will result in authentication failures.

Save the integration to connect and authenticate to Confluence.

InputNotesExample
API Site Override

By default this connector connects to the first Confluence site this user has access to. If you have multiple Confluence sites, specify which one you would like to connect to using the site name or the full URL.

example or https://example.atlassian.net
Authorize URL

The OAuth 2.0 Authorization URL for Confluence.

https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent
Client ID

The OAuth 2.0 Client ID. Obtain this from your Atlassian Developer Console.

1MDP9i8hFPTf2RcT6mdYchLgOyB9DO
Client Secret

The OAuth 2.0 Client Secret. Obtain this from your Atlassian Developer Console.

Scopes

A space-delimited set of one or more scopes to get the user's permission to access. See Confluence OAuth 2.0 Scopes for details.

offline_access delete:attachment:confluence read:attachment:confluence write:attachment:confluence read:custom-content:confluence write:custom-content:confluence delete:custom-content:confluence read:page:confluence write:page:confluence delete:page:confluence read:space:confluence
Token URL

The OAuth 2.0 Token URL for Confluence.

https://auth.atlassian.com/oauth/token

Triggers

New and Updated Pages

Checks for new and updated pages on a configured schedule. | key: pagesPollingTrigger

InputNotesExample
Connection

The Confluence connection to use.

Checks for new and updated pages on a configured schedule.

This trigger monitors Confluence pages for changes using the Confluence Cloud REST API v2 pages endpoint. Pages are categorized as either newly created or updated based on their timestamps.

How It Works

  1. Runs on the configured schedule (e.g., every 5 minutes)
  2. Queries the Confluence API for pages sorted by modification date (sort=-modified-date)
  3. Filters pages based on their version createdAt timestamp compared to the last poll time
  4. Categorizes pages as "created" (page created since last poll) or "updated" (page modified but not created since last poll)
  5. Maintains state automatically to track the last poll time
  6. Returns all pages as "created" on the first run (when no previous poll state exists)

The trigger uses cursor-based pagination to retrieve all modified pages across multiple API requests if necessary.

Configuration

Inputs:

  • Connection: Confluence OAuth 2.0 connection with appropriate permissions to view pages

The schedule is configured in the integration's trigger configuration within the Prismatic platform.

Returned Data

The trigger returns pages categorized by change type:

Example Response
{
"data": {
"created": [
{
"id": "12345678",
"title": "API Integration Guide",
"createdAt": "2026-01-27T10:30:00.000Z",
"version": {
"createdAt": "2026-01-27T10:30:00.000Z",
"message": "Initial version",
"number": 1,
"minorEdit": false,
"authorId": "user123"
}
}
],
"updated": [
{
"id": "87654321",
"title": "Architecture Overview",
"createdAt": "2026-01-20T09:00:00.000Z",
"version": {
"createdAt": "2026-01-27T11:15:00.000Z",
"message": "Updated deployment section",
"number": 5,
"minorEdit": false,
"authorId": "user456"
}
}
]
}
}

New Spaces

Checks for new spaces on a configured schedule. | key: newSpacesPollingTrigger

InputNotesExample
Connection

The Confluence connection to use.

Checks for new spaces on a configured schedule.

This trigger monitors the Confluence site for newly created spaces using the Confluence Cloud REST API v2 spaces endpoint.

How It Works

  1. Runs on the configured schedule (e.g., every 5 minutes)
  2. Queries the Confluence API to retrieve all spaces accessible to the authenticated user
  3. Filters spaces based on their createdAt timestamp compared to the last poll time
  4. Returns only spaces created since the last poll
  5. Maintains state automatically to track the last poll time
  6. Returns all spaces on the first run (when no previous poll state exists)

The trigger uses cursor-based pagination to retrieve all spaces across multiple API requests if necessary.

Configuration

Inputs:

  • Connection: Confluence OAuth 2.0 connection with appropriate permissions to view spaces

The schedule is configured in the integration's trigger configuration within the Prismatic platform.

Returned Data

The trigger returns newly created spaces with the following structure:

Example Response
{
"data": [
{
"id": "12345678",
"name": "Engineering Team Space",
"createdAt": "2026-01-27T10:30:00.000Z"
},
{
"id": "87654321",
"name": "Product Documentation",
"createdAt": "2026-01-27T11:15:00.000Z"
}
]
}

Data Sources

List Pages

Returns all pages. | key: listPages | type: picklist

InputNotesExample
Connection

The Confluence connection to use.

Space Id

The space ID to list pages from.

123456789

List Spaces

Returns all spaces. | key: listSpaces | type: picklist

InputNotesExample
Connection

The Confluence connection to use.

Sort by Name

Sort the spaces by name.

false

Actions

Create Content Property for Attachment

Creates a new content property for an attachment. | key: createContentPropertyForAttachment

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Body Data

The content property data to create or update.

Connection

The Confluence connection to use.

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Create Content Property for Custom Content

Creates a new content property for a Custom Content. | key: createContentPropertyForCustomContent

InputNotesExample
Body Data

The content property data to create or update.

Connection

The Confluence connection to use.

Custom Content Id

The unique identifier of the custom content.

123456789

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Create Content Property for Page

Creates a new content property for a page. | key: createContentPropertyForPage

InputNotesExample
Body Data

The content property data to create or update.

Connection

The Confluence connection to use.

Page Id

The unique identifier of the page.

123456789

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Create Page

Creates a page in the space. | key: createPage

InputNotesExample
Body

The body of the page.

Connection

The Confluence connection to use.

Embedded

When true, tags the content as embedded and creates content in NCS.

false
Parent Id

The unique identifier of the parent page.

987654321
Private

When true, the page will be private and only the user who creates the page will have permission to view and edit it.

false
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Space Id

The unique identifier of the space.

123456789
Status

The status of the page.

Title

The title of the page.

Product Documentation

{
"data": {
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
}
}

Delete Attachment

Deletes a specific attachment. | key: deleteAttachment

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Connection

The Confluence connection to use.

Purge

When true, permanently deletes the attachment instead of moving it to trash.

false

{
"data": null
}

Delete Content Property for a Custom Content

Deletes a content property for a Custom Content by its id. | key: deleteContentPropertyForCustomContent

InputNotesExample
Connection

The Confluence connection to use.

Custom Content Id

The unique identifier of the custom content.

123456789
Property Id

The unique identifier of the content property.

content-prop-123

{
"data": null
}

Delete Content Property for an Attachment

Deletes a content property for an attachment by its id. | key: deleteContentPropertyForAttachment

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Connection

The Confluence connection to use.

Property Id

The unique identifier of the content property.

content-prop-123

{
"data": null
}

Delete Content Property for Page

Deletes a content property for a page by its id. | key: deleteContentPropertyForPage

InputNotesExample
Connection

The Confluence connection to use.

Page Id

The unique identifier of the page.

123456789
Property Id

The unique identifier of the content property.

content-prop-123

{
"data": null
}

Delete Page

Delete a page by id. | key: deletePage

InputNotesExample
Connection

The Confluence connection to use.

Draft

When true, deletes a page that is in draft status.

false
Page Id

The unique identifier of the page.

123456789
Purge

When true, permanently deletes the page instead of moving it to trash.

false

{
"data": null
}

Get Attachment

Returns a specific attachment. | key: getAttachment

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Connection

The Confluence connection to use.

Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

{
"data": {
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
}

Get Attachments for Page

Returns the attachments of specific page. | key: getPageAttachment

InputNotesExample
Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Page Id

The unique identifier of the page.

123456789
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

{
"data": {
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
},
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

Get Content Properties for Custom Content

Retrieves a specific Content Property by ID that is attached to a specified custom content. | key: getContentPropertiesForCustomContent

InputNotesExample
Connection

The Confluence connection to use.

Custom Content Id

The unique identifier of the custom content.

123456789
Property Id

The unique identifier of the content property.

content-prop-123

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Get Content Property for Attachment

Retrieves a specific Content Property by ID that is attached to a specified attachment. | key: getContentPropertiesForAttachments

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Connection

The Confluence connection to use.

Property Id

The unique identifier of the content property.

content-prop-123

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Get Content Property for Page

Retrieves a specific Content Property by ID that is attached to a specified page. | key: getContentPropertiesForPage

InputNotesExample
Connection

The Confluence connection to use.

Page Id

The unique identifier of the page.

123456789
Property Id

The unique identifier of the content property.

content-prop-123

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Get Page

Returns a specific Page. | key: getPage

InputNotesExample
Body Format

The content format types to be returned in the body field of the response.

Connection

The Confluence connection to use.

Get Draft

Retrieve the draft version of this page.

Include Favorited By Current User Status

When true, includes whether this page has been favorited by the current user.

false
Include Labels

When true, includes labels associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order.

false
Include Likes

When true, includes likes associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order.

false
Include Operations

When true, includes operations associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order.

false
Include Properties

When true, includes content properties associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order.

false
Include Version

When true, includes the current version associated with this page in the response.

true
Include Versions

When true, includes versions associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order.

false
Page Id

The unique identifier of the page.

123456789
Version

Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

47

{
"data": {
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
}
}

Get Space

Returns a specific space. | key: getSpace

InputNotesExample
Connection

The Confluence connection to use.

Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Space Id

The unique identifier of the space.

123456789

{
"data": {
"id": "<string>",
"key": "<string>",
"name": "<string>",
"type": "global",
"status": "current",
"authorId": "<string>",
"createdAt": "<string>",
"homepageId": "<string>",
"description": {
"plain": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"icon": {
"path": "<string>",
"apiDownloadLink": "<string>"
},
"_links": {
"webui": "<string>"
}
}
}

List Attachments

Returns all attachments. | key: listAttachments

InputNotesExample
Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

{
"data": {
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
},
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

List Content Properties for Attachments

Retrieves all Content Properties tied to a specified attachment. | key: listContentPropertiesForAttachments

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Sort

Used to sort the result by a particular field.

{
"data": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
},
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

List Content Properties for Custom Content

Retrieves Content Properties tied to a specified Custom Content. | key: listContentPropertiesForCustomContent

InputNotesExample
Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Custom Content Id

The unique identifier of the custom content.

123456789
Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Sort

Used to sort the result by a particular field.

{
"data": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
},
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

List Content Properties for Page

Retrieves Content Properties tied to a specified page. | key: listContentPropertiesForPage

InputNotesExample
Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Page Id

The unique identifier of the page.

123456789
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Sort

Used to sort the result by a particular field.

{
"data": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
},
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

List Pages

Returns all pages. | key: listPages

InputNotesExample
Body Format

The content format types to be returned in the body field of the response.

Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Id

Filter the results based on page IDs. Multiple page IDs can be specified as a comma-separated list.

123456789,987654321
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Sort

Used to sort the result by a particular field.

Space Id

Filter the results based on space IDs. Multiple space IDs can be specified as a comma-separated list.

123456789,987654321
Status

Filter the results to pages based on their status. By default, current and archived are used. Valid values: current, archived, deleted, trashed

current,archived
Title

Filter the results to pages based on their title.

Product Documentation

{
"data": {
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
},
{
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

List Pages in Space

Returns all pages in a space. | key: listPagesInSpace

InputNotesExample
Body Format

The content format types to be returned in the body field of the response.

Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Depth

Filter the results to pages at the root level of the space or to all pages in the space.

Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Sort

Used to sort the result by a particular field.

Space Id

The unique identifier of the space.

123456789
Status

The status of the page.

Title

Filter the results to pages based on their title.

Product Documentation

{
"data": {
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
},
{
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

List Spaces

Returns all spaces. | key: listSpaces

InputNotesExample
Connection

The Confluence connection to use.

Cursor

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

c25hcHNob3RzLzE1NjQ4NjQ3MjMvMjU=
Fetch All

When enabled, fetches all results by automatically paginating through all pages. When disabled, returns a single page of results.

false
Limit

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

25
Query Parameters

Query parameters to pass in to your request. Ex. Key: include-versions Value: true

{
"data": {
"results": [
{
"id": "<string>",
"key": "<string>",
"name": "<string>",
"type": "global",
"status": "current",
"authorId": "<string>",
"createdAt": "<string>",
"homepageId": "<string>",
"description": {
"plain": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"icon": {
"path": "<string>",
"apiDownloadLink": "<string>"
},
"_links": {
"webui": "<string>"
}
},
{
"id": "<string>",
"key": "<string>",
"name": "<string>",
"type": "global",
"status": "current",
"authorId": "<string>",
"createdAt": "<string>",
"homepageId": "<string>",
"description": {
"plain": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"icon": {
"path": "<string>",
"apiDownloadLink": "<string>"
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>"
}
}
}

Raw GraphQL Request

Send raw GraphQL request to Confluence | key: graphqlRequest

InputNotesExample
Connection

The Confluence connection to use.

Headers

Custom headers to send along with your request

Query or Mutation
Variables

Variables to pass in to your query or mutation


Raw Request

Send raw HTTP request to Confluence | key: rawRequest

InputNotesExample
Connection

The Confluence connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/wiki/api/v2/attachments/attachments), The base URL is already included (https://{your-domain}). For example, to connect to https://{your-domain}/wiki/api/v2/attachments, only /wiki/api/v2/attachments/attachments is entered in this field.

/wiki/api/v2/attachments/attachments
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Update Content Property for Attachment

Update a content property for attachment by its id. | key: updateContentPropertyForAttachment

InputNotesExample
Attachment Id

The unique identifier of the attachment.

att123456789
Body Data

The content property data to create or update.

Connection

The Confluence connection to use.

Property Id

The unique identifier of the content property.

content-prop-123

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Update Content Property for Custom Content

Update a content property for a Custom Content by its id. | key: updateContentPropertyForCustomContent

InputNotesExample
Body Data

The content property data to create or update.

Connection

The Confluence connection to use.

Custom Content Id

The unique identifier of the custom content.

123456789
Property Id

The unique identifier of the content property.

content-prop-123

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Update Content Property for Page

Update a content property for a page by its id. | key: updateContentPropertyForPage

InputNotesExample
Body Data

The content property data to create or update.

Connection

The Confluence connection to use.

Page Id

The unique identifier of the page.

123456789
Property Id

The unique identifier of the content property.

content-prop-123

{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}

Update Page

Update a page by id. | key: updatePage

InputNotesExample
Body

The body of the page.

Connection

The Confluence connection to use.

Page Id

The unique identifier of the page.

123456789
Parent Id

The unique identifier of the parent page.

987654321
Space Id

The unique identifier of the space.

123456789
Status

The status of the page.

Title

The title of the page.

Product Documentation
Version

The version of the page.

{
"data": {
"id": "<string>",
"status": "current",
"title": "<string>",
"spaceId": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 57,
"authorId": "<string>",
"ownerId": "<string>",
"lastOwnerId": "<string>",
"createdAt": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>",
"editui": "<string>",
"tinyui": "<string>"
}
}
}

Changelog

2026-01-27

Added polling triggers for monitoring Confluence content:

  • New Spaces - Polling trigger that checks for new spaces on a configured schedule
  • New and Updated Pages - Polling trigger that monitors pages for new and updated content on a configured schedule, categorizing changes by type