Confluence Cloud
App Vendor: Atlassian
App Category: IT Services
Connector Version: 1.1.0
API Version: v1
About App
Confluence Cloud is a content collaboration and management workspace which unifies people, knowledge, and ideas.
The Confluence Cloud app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Fetch Content | This action retrieves content in a Confluence instance. |
Update Content | This action updates the details of content. |
Get Content by ID | This action returns content in a Confluence instance. |
Get Content Search | This action returns content in a Confluence instance. |
Get Content Properties | This action returns the properties for content. |
Update Content Properties | This action updates an existing property. |
Get Content History | This action returns the most recent update for content. |
Configuration Parameters
The following configuration parameters are required for the Confluence Cloud app to communicate with the Confluence Cloud enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
Base URL | Enter the base URL. Example: "https://your-domain.atlassian.net" | Text | Required | |
Username | Enter the username. Example: "sampleuser" | Text | Required | |
Token | Enter the personal access token belonging to the associated user. | Text | Required |
Action: Fetch Content
This action retrieves content in a Confluence instance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
Content Type | Enter the content type that you need to retrieve. Example: "blogpost" | Text | Optional | Default value: page Allowed values:
|
Expand | Enter a comma-separated list of properties to expand on the content. Example: "operations" | Text | Optional | By default, the following objects are expanded: For more information on the supported properties, see Expand. |
Limit | Enter the number of items that you need to retrieve. Example: 50 | Integer | Optional | Default value: 25 |
Extra Parameters | Enter the extra parameter to filter the result. | Key Value | Optional | Allowed keys:
|
Example Request
[
{
"limit": 50,
"expand": "operations",
"cont_type": "page"
}
]Action: Update Content
This action updates the details of a content.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the ID of the content to be updated. Example: "17269290" | Text | Required | This parameter can be retrieved using the Fetch Content action. |
Version | Enter the new version for the updated content. Example: 65 | Integer | Required | This can be retrieved using the Get Content by ID action. |
Type | Enter the type of content. Examples: "page"
| Text | Required | |
Title | Enter the updated title of the content. Example: "sampletitle" | Text | Required | The maximum character length for the title is 255. |
Status | Enter the updated status of the content. Example: "current" | Text | Required | Allowed values:
|
Ancestors ID | Enter the ancestor's ID for the content. Example: 2 | Integer | Required | |
Body | Enter the updated body of content. Example: $JSON[{"view": {"value": "page", "representation": "view"}}] | Any | Required | This can be retrieved using the Fetch Content action. |
Example Request
[
{
"id": "17269290",
"body": {
"view": {
"value": "page",
"representation": "view"
}
},
"type": "page",
"title": "sampletitle",
"status": "current",
"version": 65,
"ancestors_id": 2
}
]Action: Get Content by ID
This action returns a particular content in a confluence instance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the ID of the content to be returned. Example: 17269290 | Integer | Required | This parameter can be retrieved using the Fetch Content action. |
Example Request
[
{
"id": 17269290
}
]Action: Get Content Search
This action returns a particular content in a confluence instance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Type | Enter the type. Example: "page" | Text | Required | Allowed values:
|
Limit | Enter the maximum number of content objects to be returned. Example: 10 | Integer | Optional | Default value:25 |
Example Request
[
{
"type": "page",
"limit": 10
}
]Action: Get Content Properties
This action returns the properties for a content.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the ID of the content to be queried for its properties. Example: 999981282 | Integer | Required | This can be retrieved using the Fetch Content action. |
Key | Enter the key of the content property. Example: $LIST[editor] | List | Optional | |
Limit | Enter the limit. Example: 20 | Integer | Optional | Default value: 10 |
Expand | Enter the properties of the content that is to be expanded. Example: $LIST[version] | List | Optional | Allowed values:
Default value: version |
Start | Enter the starting index of the returned properties. Example: 1 | Integer | Optional | Default value: 0 |
Example Request
[
{
"id":999981282,
"key":[
"editor"
],
"limit":20,
"expand":[
"version"
],
"start":1
}
]Action: Update Content Properties
This action updates an existing property.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the ID of the content that the property belongs to. Example: 999981282 | Integer | Required | This can be retrieved using the Fetch Content action. |
Key | Enter the key of the property. Example: "editor" | Text | Required | |
Version | Enter the version number of the property. Example: 8 | Integer | Required | |
Value | Enter the value of the content property. | Any | Optional | This can be empty or a complex object. |
Example Request
[
{
"id": 999981282,
"key": "editor",
"version": 8
}
]Action: Get Content History
This action returns the most recent update a content.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the ID of the content to be queried for its history. Example: 999981282 | Integer | Required | This can be retrieved using the Fetch Content action. |
Expand | Enter the properties of the content that to be expanded. Example: $LIST[contributors] | List | Optional | Allowed values:
|
Example Request
[
{
"id": 999981282,
"expand": [
'contributors'
]
}
]