How to use IBM® App Connect with Confluence

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 page.

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 at the upper right of the screen, 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 page.

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 required 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 on the Atlassian Developer page.

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.

Confluence actions

Your flow completes these actions on this application.

Attachments

Retrieve all attachments

Create attachment

Retrieve attachments

Delete attachment

Update attachment

Download attachment content

Audit logs

Change retention period

Get retention period

Blog posts

Retrieve all blog posts

Create blog post

Retrieve blog posts

Delete blog post

Update blog post

Download blog post content

Add blog post watcher

Get blog post watch status

Remove blog post watcher

Comments

Retrieve all comments

Create comment

Retrieve comments

Delete comment

Update comment

Download comment content

Groups

Retrieve groups

Labels

Controller for label object

Create label

Retrieve labels

Delete label

Add label watcher

Get label watch status

Remove label watcher

Pages

Retrieve all pages

Create page

Publish shared draft

Publish legacy draft

Retrieve pages

Delete page

Update page

Download page content

Add page watcher

Get page watch status

Remove page watcher

Copy page hierarchy

Properties

Create property

Retrieve properties

Delete property

Update property

Restrictions

Create restriction

Retrieve restrictions

Delete restriction

Update restriction

Spaces

Retrieve all spaces

Create space

Retrieve spaces

Delete space

Update space

Download homepage content

Add space watcher

Get space watch status

Remove space watcher

Users

Retrieve users

Versions

Controller for version object

Retrieve versions