Skip to main content
Skip table of contents

Confluence Connector v1.0

1. General Information

Login to Confluence using the correct credentials

 

image-20241007-100509.png

After logging in you will be directed to below page.

image-20241231-000416.png

2. Authentication

API Token

To authenticate with Confluence, the user needs to create a API token.

image-20241231-000455.png

Click on Create API Token button:

image-20241007-101322.png

Click on Create button to generate new token.

3. Connector Actions and Tests

Action Name / Method

Space: Get space by id (GET)

Action Description

This action allows you to retrieve information about a specific space in your Confluence instance. A "space" in Confluence is a designated area for organizing related content, such as pages and blog posts

Test Case

 

Request Body Name

Parameter

 

ID

 

Description-format

 

 

image-20241007-110314.png

 

Action Name / Method

Page: Create page (POST)

Action Description

Create a new page within a Confluence space. You can define its title, content, and other metadata.

Test Case

 

Request Body Name

Parameter

 

Space ID

 

Title

 

Status

image-20241007-151525.png

Action Name / Method

Misc: Search on Confluence with CQL (GET)

Action Description

Search on Confluence with CQL (Confluence Query Language) allows you to perform advanced searches on a Confluence instance via the Confluence REST API. This is especially useful when you want to filter search results based on various attributes like titles, labels, spaces, creators, or dates.

Test Case

 

Request Body Name

Parameter

 

Cql

image-20241007-152639.png

 

Action Name / Method

Page: Get page by id (GET)

Action Description

This action is used to retrieve a specific Confluence page based on its unique identifier (ID). Every page in Confluence has a unique ID, and this API allows you to fetch detailed information about that page, including its content, metadata, version history, and more.

Test Case

 

Request Body Name

Parameter

 

ID

image-20241007-152937.png

 

Action Name / Method

Page: Update page (POST)

Action Description

Update page metadata

Test Case

 

Request Body Name

Parameter

 

Space ID

 

Title

 

Status

 

ID

image-20241007-153245.png

4. Connection Settings and Configuration

 

Settings Parameters

Value

Description

Required (Y/N)

Default Value

Connector

Confluence

Connector Name

Y

Confluence

Host Name

Endpoint required for performing CRUD

Y

Authentication

Basic

Type of authentication

Y

 

User Name

 

Y

Password

<developer-token>

 

Y

<developer-token>

image-20241231-000614.png

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.