Confluence Custom Widget

Overview

The Confluence custom widget enables users to access Confluence pages from within ServiceDesk Plus for quick reference to documentation, solutions, and other relevant content.

This article provides easy-to-follow, step-by-step instructions to set up the Confluence custom widget in ServiceDesk Plus.

Step 1: Create a new service

Go to Admin > Developer Space > Connection > Custom Services > Create Service.

Name the service.

The Service Name must contain only alphanumeric characters, either as a single word or in snake case. For example, confluence or sdp_confluence.

Set the Authentication Type to Basic Authentication.
Click Create Service.

Step 2: Create a connection

After you create the service, click Create Connection.

Name the connection, similar to the service name.
Click Create and Connect.

Step 3: Establish the connection

Click Connect to authorize the connection.

Use your Confluence credentials for authorization:
- Username: Your Confluence username
- Password: Your Confluence API key. (You can check/create your API keys here)

3. Click Connect.

Step 4: Configure the Widget

Download the confluence custom widget zip from here and unzip it.
Open the conf.json file in a text editor.
Locate the confDomain parameter and update it with your Confluence instance's domain.
- Example: "confDomain": "https://<your_confluence_instanceURL>.atlassian.net"
After you complete the configuration, re-zip all the files of the widget.

Do not select the folder. Instead, select all the files and zip them.

Step 5: Upload the custom widget

Go to Admin > Developer Space > Custom Widget.
Click + Custom Widget.
Upload the zipped widget file.

After you upload the zip file, the widget will be available for use.

How to access the Confluence custom widget in ServiceDesk Plus

Go to an existing request in ServiceDesk Plus.
You should now see a Confluence tab added to the request details page.

Use the widget to search for and view Confluence pages from within ServiceDesk Plus. You can search for pages by title or view details of specific pages.

Troubleshooting

If the pages don't load, check whether your Confluence domain is correctly set in the conf.json file and that your connection is authorized.
Ensure that your ServiceDesk Plus instance's security settings do not contain any CSP headers that might be blocking the widget.
If the CSP headers are necessary, add your Confluence domain as a header under Content Security Policy and then check the widget.
The widget requires an active connection to Confluence with proper authorization. Make sure your API key is valid and has the necessary permissions to access Confluence content.