How to use IBM® App Connect with Confluence

Confluence is a content collaboration tool that helps teams to create, share, and manage content in a centralized repository.

Availability:

App Connect connector
Local connector in containers (Continuous Delivery release)
Local connector in containers (Long Term Support Cycle-2 release)

Connecting to Confluence
General considerations
Events and actions

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Confluence

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) or flow editor. If necessary, work with your Confluence administrator to obtain these values.

Endpoint URL

The Confluence server URL for your Confluence hosting option

Enter the domain-specific Confluence service URL that you use to log in to the portal.

For Confluence Cloud, if your domain is xxx, the service URL is https://xxx.atlassian.net
For Confluence Server, the service URL is in the format https://myconfluencehost:port

For more information, see Confluence URL list on the Confluence support site.

User name

The username for your Confluence account

For Confluence Cloud, enter the email address that you use to log in to your Atlassian account.
For Confluence Server, enter the username that you use to log in to Confluence.

To find the username for your Confluence account, click your profile picture, then choose Profile, or choose the Profile link in the sidebar of your personal space. For more information, see Your User Profile on the Confluence support site.

Note: In the Confluence Cloud service, you use your Atlassian ID to log in. However, if you have a Confluence Server, then the user management is not hosted with Atlassian. It is either hosted on the Confluence Server itself, on a Jira Server connected to Confluence, or your company's external user management.

Password or API token

The password for your Confluence on-premises account, or API token for your Confluence cloud account

For Confluence Cloud, enter the API token that you generate from your Atlassian account.
For Confluence Server, enter the password that you use to log in to Confluence.

To find the API token for your Confluence Cloud account, complete the following steps:

Rest API URI

The REST API URI for your Confluence Server service. This value is needed only if you are connecting to a Confluence on-premises instance. For an on-premises setup that is customized to deploy with context, specify the API URI as /<contextName>/rest/api. For a setup without context, specify the API URI as /rest/api.

For more information, see Confluence Server REST API in the Atlassian Developer documentation.

To connect to a Confluence endpoint from the App Connect Designer Applications and APIs page for the first time, expand Confluence, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with Confluence, take note of the following considerations:

(General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
(General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

Confluence events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Confluence actions

Your flow completes these actions on this application.

Object	Action	Description
Anonymous users	Retrieve all anonymous users	Retrieves all the anonymous users in Confluence
Attachments	Create attachment	Create a new attachment for the customer
	Delete attachment	Deletes an attachment by using ID
	Download attachment content	Downloads the attachment content
	Retrieve all attachments	Returns all attachments
	Retrieve attachments	Returns all the attachments
	Update attachment	Updates an attachment by using ID
Audit logs	Change retention period	Changes the retention period
Audit logs	Retrieve retention period	Retrieves the retention period
Blog posts	Add blog post watcher	Adds a blog post watcher
	Create blog post	Create a new blog post for the customer
	Delete blog post	Deletes a blog post by using ID
	Download blog post content	Downloads the blog post content
	Retrieve blog post watch status	Retrieves the blog post watch status
	Remove blog post watcher	Removes a blog post watcher
	Retrieve all blog posts	Returns all the blog posts
	Retrieve blog posts	Returns all the blog posts
	Update blog post	Updates a blog post by using ID
Comments	Create comment	Creates a new comment for the customer
	Delete comment	Delete a comment by using ID
	Download comment content	Downloads a comment content
	Retrieve all comments	Returns all the comments
	Retrieve comments	Returns all the comments
	Update comment	Update a comment by using ID
Group members	Retrieve group members	Returns the users that are members of a group
Groups	Retrieve groups	Returns all the user groups
Labels	Add label watcher	Adds a label watcher
	Create label	Creates a new label for the customer
	Delete label	Deletes a label for the customer
	Remove label watcher	Removes a label watcher
	Retrieve labels	Retrieves all labels for the customer
	Retrieve label watch status	Retrieves the label watch status
Pages	Add page watcher	Adds a page watcher
	Copy page hierarchy	Copies page hierarchy
	Create page	Creates a new page for the customer
	Delete page	Deletes a page by using ID
	Download page content	Downloads page content
	Publish legacy draft	Publishes a legacy draft
	Publish shared draft	Publishes a shared draft
	Remove page watcher	Removes a page watcher
	Retrieve all pages	Returns all the pages
	Retrieve pages	Returns all the pages
	Retrieve page watch status	Retrieves page watch status
	Update page	Updates a page by using ID
Properties	Create property	Creates a new property for the customer
	Delete property	Deletes all the properties
	Retrieve properties	Returns all the properties
	Update property	Updates all the properties
Restrictions	Create restriction	Creates a new restriction for the customer
	Delete restriction	Deletes all the restrictions
	Retrieve restrictions	Returns all the restrictions
	Update restriction	Updates all the restrictions
Spaces	Add space watcher	Adds a space watcher
	Create space	Creates a new space for the customer
	Delete space	Permanently deletes a space
	Download homepage content	Downloads the homepage content
	Remove space watcher	Removes a space watcher
	Retrieve all spaces	Returns all the spaces
	Retrieve spaces	Retrieves all the spaces for the customer
	Retrieve space watch status	Retrieves a space watch status
	Update space	Updates the name, description, or homepage of a space
Users	Retrieve users	Retrieves all users for the customer
Versions	Retrieve versions	Returns the versions of a specific page, blog post, attachment, or comment