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: confluenceDescription
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.
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-userread:confluence-space.summary read:confluence-propsread:confluence-content.allread:confluence-content.summaryread:confluence-content.permissionread:confluence-groups readonly:content.attachment:confluencewrite:confluence-contentwrite:confluence-spacewrite:confluence-filewrite:confluence-propsmanage:confluence-configurationsearch:confluence write:confluence-groups - From here you can do any additional configuration to match your use case using the Granular scopes tab.
Data Sources
List Pages
Returns all pages. | key: listPages | type: picklist
List Spaces
Returns all spaces. | key: listSpaces | type: picklist
Actions
Create Content Property for Attachment
Creates a new content property for an attachment. | key: createContentPropertyForAttachment
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"data": null
}
Delete Content Property for a Custom Content
Deletes a content property for a Custom Content by its id. | key: deleteContentPropertyForCustomContent
Output Example Payload
{
"data": null
}
Delete Content Property for an Attachment
Deletes a content property for an attachment by its id. | key: deleteContentPropertyForAttachment
Output Example Payload
{
"data": null
}
Delete Content Property for Page
Deletes a content property for a page by its id. | key: deleteContentPropertyForPage
Output Example Payload
{
"data": null
}
Delete Page
Delete a page by id. | key: deletePage
Output Example Payload
{
"data": null
}
Get Attachment
Returns a specific attachment. | key: getAttachment
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"data": {
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
}
Get Page
Returns a specific Page. | key: getPage
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Raw Request
Send raw HTTP request to Confluence | key: rawRequest
Update Content Property for Attachment
Update a content property for attachment by its id. | key: updateContentPropertyForAttachment
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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>"
}
}
}