The XO Platform lets you easily connect with your Confluence instance to create, and view pages or blogs on the Confluence space. Learn more about Confluence.
This article explains how to authorize and enable the Confluence action and install the pre-built template.
Authorizations Supported
The Kore.ai XO Platform supports OAuth v2.0 authentication to allow a Confluence integration to exchange data. For more information, see Bot Authorization Overview.
The Kore.ai XO Platform supports the following authorization types for the Confluence integration:
- Pre-Authorize the Integration – To make the integration process smoother for developers and customers, you can pre-authorize it by providing the necessary authorization credentials to obtain the access token.
- Allow Users to Authorize the Integration – This method requires the end user to provide credentials during the conversation for authorization. This authorization process involves requesting permission for Kore.ai’s Confluence app to access an access token at runtime.
NOTE: The Confluence integration can be authorized only for the Developer and the Enterprise editions. You cannot authorize Confluence’s Trial edition. To learn more about Confluence, see Confluence documentation.
Authorization Type | Basic OAuth |
Pre-authorize the Integration | Yes |
Allow Users to Authorize the Integration | Yes |
Step 1: Enable the Confluence Action
Prerequisites:
Before enabling the Confluence actions, complete the following prerequisites:
- Create a developer account in Atlassian and note down login credentials.
- Create an OAuth app in Atlassian and grant permission to write:confluence-content offline_access. See Confluence Documentation for more information
- Copy the Client ID, Client Secret Key, Authorization URL, and Callback URL and keep them ready to enable the Confluence integration.
Steps to enable the Confluence action:
Pre-authorize the Integration
OAuth
You can authorize the integration using developer credentials. The developer authorization lets you authorize the integration with the preconfigured Kore.ai app or use the custom authorization profile to let a developer configure the integration.
Steps to authorize a Confluence action using developer credentials:
- Go to Build > Integrations > Actions and select the Confluence action.
- In the Configurations dialog, select the Authorization tab.
- Enter the following details:
-
- Authorization Type – Select the Pre-authorize the Integration option, and then select the OAuth option.
System Authorization
Pre-authorize Confluence integration with the necessary authorization credentials to obtain the token to access external services. - Select the System card to enable Kore.ai’s preconfigured Confluence app and click Authorize.
- Once you click Authorize, you are redirected to https://auth.atlassian.com/authorize.
- Enter your developer account credentials to connect with your Confluence Account successfully.
- Click the Allow Access button to use Kore.ai’s app to fetch the access token to complete the authorization.
Custom Authorization
Create your custom authorization profile to obtain an access token and use it to complete integration without using Kore.ai’s Confluence app for authorization. - Select Custom to enable the custom authorization profile.
- Click the Select Authorization drop-down and select the Create New option.
- Select the type of authorization mechanism. For example, select the OAuth v2 option. To create custom OAuth profiles, read the Setting Up Authorization Using OAuth v2 article.
- Enter the following authentication credentials for the OAuth v2 mechanism:
- Click Save Auth to save Authorization Profile.
- Authorization Type – Select the Pre-authorize the Integration option, and then select the OAuth option.
-
- Select the new Authorization Profile you created to enable integration.
- Once you click Authorize, you are redirected to https://auth.atlassian.com/authorize
- Enter login credentials to connect with your Confluence Account successfully.
- Click the Allow Access button if prompted to let your custom app fetch the access token to complete the authorization.
- Once the authorization is successful, you will see a success message.
- Click Save. When you configure the action for the first time, the Integration Successful pop-up is displayed.
Note: The Confluence action is moved from Available to Configured region. - You can also click the Skip for Now button to install the Dialog Task templates later. To learn how to use action templates, read the Using the Confluence Action Templates article.
Allow End User to Authorize
You can authorize the integration at a user level with their login credentials. The user authorization process involves requesting permission for Kore.ai’s Confluence app to access an access token at runtime. You can also use the custom authorization profile to fetch the access token based on user credentials.
Steps to authorize a Confluence action at a user level:
- Go to Build > Integrations > Actions and select the Confluence action.
- In the Configurations dialog, select the Authorization tab.
- Enter the following details:
- Authorization Type – Select the Allow Users to Authorize the Integration option, and then select the OAuth option.
System Authorization
The end user has to provide credentials during the conversation to authorize users for Confluence integration to obtain the access token. - Select the System card to enable Kore.ai’s preconfigured Confluence app.
- Once you click the Enable button, a link is sent to the end user to authorize the integration.
- Click the link and enter the login credentials to allow the user to authorize the integration.
Custom Authorization
Create your custom authorization profile to obtain an access token and use it to complete integration without using Kore.ai’s Confluence app for authorization. - Select Custom to enable the custom authorization profile.
- Click the Select Authorization drop-down and select the Create New option. Follow the instructions in the Custom Authorization section.
- You can also select an existing authorization profile as shown below:
- Click the Enable button. The users will see the authorize option during the runtime.
- Authorization Type – Select the Allow Users to Authorize the Integration option, and then select the OAuth option.
Step 2: Install the Confluence Action Templates
Once you have configured a Confluence integration, you can explore and install action templates.
Steps to install action templates:
- On the Integration Successful dialog, click the Explore Templates button to view the templates.
- In the Integration Templates dialog, click the Install button for a template to begin the installation.
- Once the template is installed, click the Go to Dialog button to view the dialog task.
- Once all templates are installed, a dialog task for each template is auto-created.
- Select the desired dialog task from the templates and click Proceed. For example, select the Create Content task.
- Once you click Proceed, the dialog task is auto-created, and the canvas opens with all required entity nodes, service nodes, and message scripts.