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

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

If you select Basic Auth and you are using Confluence cloud, you will need to supply your Confluence email and an API token to the connection. If you are on a locally hosted instance of Confluence, you will need to supply your Confluence email and password to the connection.

Log in to Atlassian.
Click Create API token.
From the dialog that appears, enter a memorable and concise Label for your token and click Create.
Click Copy to clipboard, then paste the token to the connection configuration of your integration.

For additional information on generating an API token from Confluence Cloud, refer to the Atlassian docs.

Input	Notes	Example
API Token	Provide an api token to authenticate all requests with. Cloud users need to generate an API token for this value.	yourApiToken
Email	Provide a valid email for the given Confluence account you want to connect.	example.user@confluence.com
Host	Provide a string value for the URL of your Confluence account.	Only <your-domain.atlassian.net> is entered here

Confluence OAuth 2.0

Navigate to the Atlassian Developer Console and create a new Oauth 2.0 integration and give it a name. Under the app details section, take note of your client Id and client secret values that were generated.
After you have saved those values, find the Authorization section and click configure on Oauth 2.0 (3LO). There you will be prompted to enter your Redirect URL https://oauth2.prismatic.io/callback.
Next navigate to the permissions. It is important that you remain consistent with the scopes you supply in both Confluence, and your connection.

The default scopes on a new connection will be as follows (Classic Scopes): read:confluence-user read:confluence-space.summary read:confluence-props read:confluence-content.all read:confluence-content.summary read:confluence-content.permission read:confluence-groups readonly:content.attachment:confluence write:confluence-content write:confluence-spacewrite:confluence-file write:confluence-props manage:confluence-configuration search:confluence write:confluence-groups These scopes will provide access to the most of the actions in the Component component, but you may have to modify the scopes in both locations (here and Atlassian Developer Console) to meet your needs.

For more information on developing Confluence applications, follow the guide here. Next, you can configure an OAuth 2.0 connection.

Add a Confluence step to your integration. This will automatically create a Confluence connection config variable.

Ensure the connection is of type Confluence OAuth 2.0 Connection and enter the following details:

For Client ID and Client Secret enter the values that you got from the Atlassian Developer Console
As stated previously Scopes will default to the following: read:confluence-user read:confluence-space.summary read:confluence-props read:confluence-content.all read:confluence-content.summary read:confluence-content.permission read:confluence-groups readonly:content.attachment:confluence write:confluence-content write:confluence-spacewrite:confluence-file write:confluence-props manage:confluence-configuration search:confluence write:confluence-groups
From here you can do any additional configuration to match your use case using the Granular scopes tab.

Input	Notes	Example
API Site Override	By default this connector connects to the first Confluence site this user has access to. If you have multiple Confluence sites, please specify which one you would like to connect to, you can use 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
Client Secret
Scopes	A space-delimited set of one or more scopes to get the user's permission to access.	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

Data Sources

List Pages

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

Input	Notes	Example
Connection
Space Id	The space ID to list pages from.	123456

List Spaces

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

Input	Notes	Example
Connection
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

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Body Data	The list of settings for this Function.
Connection
Debug Request	Enabling this flag will log out the current request.	false

{
  "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

Input	Notes	Example
Body Data	The list of settings for this Function.
Connection
Custom Content Id	The Custom Content Id.	123456
Debug Request	Enabling this flag will log out the current request.	false

{
  "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

Input	Notes	Example
Body Data	The list of settings for this Function.
Connection
Debug Request	Enabling this flag will log out the current request.	false
Page Id	The Page Id.	123456

{
  "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

Input	Notes	Example
Body	The body of the page.
Connection
Debug Request	Enabling this flag will log out the current request.	false
Embedded	Tag the content as embedded and content will be created in NCS.	false
Parent Id	The parent id.	123456
Private	The page will be private. Only the user who creates this page will have permission to view and edit one.	false
Query Parameters	Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Space Id	The Space Id.	123456
Status	The status of the page.
Title	Title of the page.	123456

{
  "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

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Connection
Debug Request	Enabling this flag will log out the current request.	false
Purge	If attempting to purge the attachment.	false

{
  "data": null
}

Delete Content Property for a Custom Content

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

Input	Notes	Example
Connection
Custom Content Id	The Custom Content Id.	123456
Debug Request	Enabling this flag will log out the current request.	false
Property Id	The ID of the content property to be returned.	123456

{
  "data": null
}

Delete Content Property for an Attachment

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

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Connection
Debug Request	Enabling this flag will log out the current request.	false
Property Id	The ID of the content property to be returned.	123456

{
  "data": null
}

Delete Content Property for Page

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

Input	Notes	Example
Connection
Debug Request	Enabling this flag will log out the current request.	false
Page Id	The Page Id.	123456
Property Id	The ID of the content property to be returned.	123456

{
  "data": null
}

Delete Page

Delete a page by id. | key: deletePage

Input	Notes	Example
Connection
Debug Request	Enabling this flag will log out the current request.	false
Draft	If attempting to delete a page that is a draft.	false
Page Id	The Page Id.	123456
Purge	If attempting to purge the page.	false

{
  "data": null
}

Get Attachment

Returns a specific attachment. | key: getAttachment

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Connection
Debug Request	Enabling this flag will log out the current request.	false
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

Input	Notes	Example
Connection
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=
Debug Request	Enabling this flag will log out the current request.	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 Page Id.	123456
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

Input	Notes	Example
Connection
Custom Content Id	The Custom Content Id.	123456
Debug Request	Enabling this flag will log out the current request.	false
Property Id	The ID of the content property to be returned.	123456

{
  "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

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Connection
Debug Request	Enabling this flag will log out the current request.	false
Property Id	The ID of the content property to be returned.	123456

{
  "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

Input	Notes	Example
Connection
Debug Request	Enabling this flag will log out the current request.	false
Page Id	The Page Id.	123456
Property Id	The ID of the content property to be returned.	123456

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

Get Page

Returns a specific Page. | key: getPage

Input	Notes	Example
Body Format	The content format types to be returned in the body field of the response.
Connection
Debug Request	Enabling this flag will log out the current request.	false
Get Draft	Retrieve the draft version of this page.
Include Favorited By Current User Status	Includes whether this page has been favorited by the current user.	false
Include Labels	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	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	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	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	Includes the current version associated with this page in the response.	true
Include Versions	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 Page Id.	123456
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

Input	Notes	Example
Connection
Debug Request	Enabling this flag will log out the current request.	false
Query Parameters	Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Space Id	The Space Id.	123456

{
  "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

Input	Notes	Example
Connection
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=
Debug Request	Enabling this flag will log out the current request.	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

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Connection
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=
Debug Request	Enabling this flag will log out the current request.	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

Input	Notes	Example
Connection
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 Custom Content Id.	123456
Debug Request	Enabling this flag will log out the current request.	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

Input	Notes	Example
Connection
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=
Debug Request	Enabling this flag will log out the current request.	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 Page Id.	123456
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

Input	Notes	Example
Body Format	The content format types to be returned in the body field of the response.
Connection
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=
Debug Request	Enabling this flag will log out the current request.	false
Id	Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list.	12345,789101
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.	12345,789101
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.	My Page

{
  "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

Input	Notes	Example
Body Format	The content format types to be returned in the body field of the response.
Connection
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=
Debug Request	Enabling this flag will log out the current request.	false
Depth	Filter the results to pages at the root level of the space or to all pages in the space.
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 Space Id.	123456
Status	The status of the page.
Title	Filter the results to pages based on their title.	My Page

{
  "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

Input	Notes	Example
Connection
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=
Debug Request	Enabling this flag will log out the current request.	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

Input	Notes	Example
Connection
Debug Request	When true, the entire request and response (including auth headers) will be logged out.	false
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

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
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

Input	Notes	Example
Attachment Id	The Attachment Id.	123456
Body Data	The list of settings for this Function.
Connection
Debug Request	Enabling this flag will log out the current request.	false
Property Id	The ID of the content property to be returned.	123456

{
  "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

Input	Notes	Example
Body Data	The list of settings for this Function.
Connection
Custom Content Id	The Custom Content Id.	123456
Debug Request	Enabling this flag will log out the current request.	false
Property Id	The ID of the content property to be returned.	123456

{
  "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

Input	Notes	Example
Body Data	The list of settings for this Function.
Connection
Debug Request	Enabling this flag will log out the current request.	false
Page Id	The Page Id.	123456
Property Id	The ID of the content property to be returned.	123456

{
  "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

Input	Notes	Example
Body	The body of the page.
Connection
Debug Request	Enabling this flag will log out the current request.	false
Page Id	The Page Id.	123456
Parent Id	The parent id.	123456
Space Id	The Space Id.	123456
Status	The status of the page.
Title	Title of the page.	123456
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>"
    }
  }
}

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

Description​

Connections​

Confluence Basic​

Confluence OAuth 2.0​

Data Sources​

List Pages​

List Spaces​

Actions​

Create Content Property for Attachment​

Create Content Property for Custom Content​

Create Content Property for Page​

Create Page​

Delete Attachment​

Delete Content Property for a Custom Content​

Delete Content Property for an Attachment​

Delete Content Property for Page​

Delete Page​

Get Attachment​

Get Attachments for Page​

Get Content Properties for Custom Content​

Get Content Property for Attachment​

Get Content Property for Page​

Get Page​

Get Space​

List Attachments​

List Content Properties for Attachments​

List Content Properties for Custom Content​

List Content Properties for Page​

List Pages​

List Pages in Space​

List Spaces​

Raw GraphQL Request​

Raw Request​

Update Content Property for Attachment​

Update Content Property for Custom Content​

Update Content Property for Page​

Update Page​

Description

Connections

Confluence Basic

Confluence OAuth 2.0

Data Sources

List Pages

List Spaces

Actions

Create Content Property for Attachment

Create Content Property for Custom Content

Create Content Property for Page

Create Page

Delete Attachment

Delete Content Property for a Custom Content

Delete Content Property for an Attachment

Delete Content Property for Page

Delete Page

Get Attachment

Get Attachments for Page

Get Content Properties for Custom Content

Get Content Property for Attachment

Get Content Property for Page

Get Page

Get Space

List Attachments

List Content Properties for Attachments

List Content Properties for Custom Content

List Content Properties for Page

List Pages

List Pages in Space

List Spaces

Raw GraphQL Request

Raw Request

Update Content Property for Attachment

Update Content Property for Custom Content

Update Content Property for Page

Update Page