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

Basic Connection

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 string / Required apiToken	Provide an api token to authenticate all requests with. Cloud users need to generate an API token for this value.	yourApiToken
Email string / Required email	Provide a valid email for the given Confluence account you want to connect.	example.user@confluence.com
Host string / Required 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, which you can find under the credentials tab in the Prismatic settings. - https://oauth2.prismatic.io/callback - as a Redirect URL. Next navigate to the permissions. It is important that you remain consistent with the scopes you supply in both Confluence, and your Prismatic connection.

The default scopes on a new connection in Prismatic 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 (Prismatic 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 within Prismatic.

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	Default	Notes	Example
API Site Override string apiSiteOverride		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 string / Required authorizeUrl	https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent	The OAuth 2.0 Authorization URL for Confluence
Client ID string / Required clientId
Client Secret password / Required clientSecret
Scopes string / Required scopes	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	A space-delimited set of one or more scopes to get the user's permission to access.
Token URL string / Required tokenUrl	https://auth.atlassian.com/oauth/token	The OAuth 2.0 Token URL for Confluence

Data Sources

List Pages

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

Input	Notes	Example
Connection connection / Required connectionInput
Space Id string spaceId	The space ID to list pages from.	123456

List Spaces

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

Input	Notes
Connection connection / Required connectionInput

Actions

Create Content Property for Attachment

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

Input	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Body Data code / Required bodyData		The list of settings for this Function.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Create Content Property for Attachment

{
  "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	Default	Notes	Example
Body Data code / Required bodyData		The list of settings for this Function.
Connection connection / Required connectionInput
Custom Content Id string / Required customContentId		The Custom Content Id.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Create Content Property for Custom Content

{
  "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	Default	Notes	Example
Body Data code / Required bodyData		The list of settings for this Function.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Page Id string / Required pageId		The Page Id.	123456

Example Payload for Create Content Property for Page

{
  "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	Default	Notes	Example
Body code / Required body		The body of the page.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Embedded boolean embedded		Tag the content as embedded and content will be created in NCS.
Parent Id string parentId		The parent id.	123456
Private boolean privateInput		The page will be private. Only the user who creates this page will have permission to view and edit one.
Query Parameters string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Space Id string / Required spaceId		The Space Id.	123456
Status string / Required status		The status of the page.
Title string / Required title		Title of the page.	123456

Example Payload for Create 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>"
    }
  }
}

Delete Attachment

Deletes a specific attachment. | key: deleteAttachment

Input	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Purge boolean purgeAttachment		If attempting to purge the attachment.

Example Payload for Delete Attachment

{
  "data": null
}

Delete Content Property for a Custom Content

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

Input	Default	Notes	Example
Connection connection / Required connectionInput
Custom Content Id string / Required customContentId		The Custom Content Id.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Delete Content Property for a Custom Content

{
  "data": null
}

Delete Content Property for an Attachment

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

Input	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Delete Content Property for an Attachment

{
  "data": null
}

Delete Content Property for Page

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

Input	Default	Notes	Example
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Page Id string / Required pageId		The Page Id.	123456
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Delete Content Property for Page

{
  "data": null
}

Delete Page

Delete a page by id. | key: deletePage

Input	Default	Notes	Example
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Draft boolean draft		If attempting to delete a page that is a draft.
Page Id string / Required pageId		The Page Id.	123456
Purge boolean purge		If attempting to purge the page.

Example Payload for Delete Page

{
  "data": null
}

Get Attachment

Returns a specific attachment. | key: getAttachment

Input	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Query Parameters string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Example Payload for Get Attachment

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Limit string limit	25	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 string / Required pageId		The Page Id.	123456
Query Parameters string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Example Payload for Get Attachments for Page

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Custom Content Id string / Required customContentId		The Custom Content Id.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Get Content Properties for Custom Content

{
  "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	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Get Content Property for Attachment

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Page Id string / Required pageId		The Page Id.	123456
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Get Content Property for Page

{
  "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	Default	Notes	Example
Body Format string bodyFormat		The content format types to be returned in the body field of the response.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Get Draft string getDraft		Retrieve the draft version of this page.
Include Favorited By Current User Status boolean includeFavoritedByCurrentUserStatus		Includes whether this page has been favorited by the current user.
Include Labels boolean includeLabels		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.
Include Likes boolean includeLikes		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.
Include Operations boolean includeOperations		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.
Include Properties boolean includeProperties		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.
Include Version boolean includeVersion		Includes the current version associated with this page in the response.
Include Versions boolean includeVersions		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.
Page Id string / Required pageId		The Page Id.	123456
Version string previousVersion		Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.	47

Example Payload for Get 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>"
    }
  }
}

Get Space

Returns a specific space. | key: getSpace

Input	Default	Notes	Example
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Query Parameters string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Space Id string / Required spaceId		The Space Id.	123456

Example Payload for Get Space

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Limit string limit	25	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 string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Example Payload for List Attachments

{
  "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	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Limit string limit	25	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 string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Sort string sort		Used to sort the result by a particular field.

Example Payload for List Content Properties for Attachments

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Cursor string 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 string / Required customContentId		The Custom Content Id.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Limit string limit	25	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 string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Sort string sort		Used to sort the result by a particular field.

Example Payload for List Content Properties for Custom Content

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Limit string limit	25	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 string / Required pageId		The Page Id.	123456
Query Parameters string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true
Sort string sort		Used to sort the result by a particular field.

Example Payload for List Content Properties for Page

{
  "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	Default	Notes	Example
Body Format string bodyFormatPages		The content format types to be returned in the body field of the response.
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Id string id		Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list.	12345,789101
Limit string limit	25	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 string sort		Used to sort the result by a particular field.
Space Id string spaceIdFilter		Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.	12345,789101
Status string statusPages		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 string titlePages		Filter the results to pages based on their title.	My Page

Example Payload for List Pages

{
  "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	Default	Notes	Example
Body Format string bodyFormatPages		The content format types to be returned in the body field of the response.
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Depth string depth		Filter the results to pages at the root level of the space or to all pages in the space.
Limit string limit	25	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 string sort		Used to sort the result by a particular field.
Space Id string / Required spaceId		The Space Id.	123456
Status string / Required status		The status of the page.
Title string titlePages		Filter the results to pages based on their title.	My Page

Example Payload for List Pages in Space

{
  "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	Default	Notes	Example
Connection connection / Required connectionInput
Cursor string 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 boolean debug	false	Enabling this flag will log out the current request.
Limit string limit	25	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 string Key Value List queryParameters		Query parameters to pass in to your request. Ex. Key: include-versions Value: true

Example Payload for List Spaces

{
  "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	Default	Notes
Connection connection / Required connection
Debug Request boolean / Required debug	false	When true, the entire request and response (including auth headers) will be logged out.
Headers string Key Value List headers		Custom headers to send along with your request
Query or Mutation code / Required query
Variables string Key Value List variables		Variables to pass in to your query or mutation

Raw Request

Send raw HTTP request to Confluence | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Update Content Property for Attachment

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

Input	Default	Notes	Example
Attachment Id string / Required attachmentId		The Attachment Id.	123456
Body Data code / Required bodyData		The list of settings for this Function.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Update Content Property for Attachment

{
  "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	Default	Notes	Example
Body Data code / Required bodyData		The list of settings for this Function.
Connection connection / Required connectionInput
Custom Content Id string / Required customContentId		The Custom Content Id.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Update Content Property for Custom Content

{
  "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	Default	Notes	Example
Body Data code / Required bodyData		The list of settings for this Function.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Page Id string / Required pageId		The Page Id.	123456
Property Id string / Required propertyId		The ID of the content property to be returned.	123456

Example Payload for Update Content Property for Page

{
  "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	Default	Notes	Example
Body code / Required body		The body of the page.
Connection connection / Required connectionInput
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Page Id string / Required pageId		The Page Id.	123456
Parent Id string parentId		The parent id.	123456
Space Id string spaceId		The Space Id.	123456
Status string / Required status		The status of the page.
Title string / Required title		Title of the page.	123456
Version code / Required version		The version of the page.

Example Payload for Update 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​

Basic Connection​

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

Basic Connection

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