Confluence

Confluence, developed by Atlassian, is a powerful collaboration and documentation platform that helps teams create, organize, and share content in a centralized space. It’s ideal for knowledge management, project documentation, and team collaboration.

How to use Confluence in ZBrain Flow

Step 1: Add Confluence to Flow

To begin integrating Confluence with your ZBrain Flow:

1. Click the ‘+’ icon in the ZBrain Flow interface.

2. In the search bar, type “Confluence”.

3. From the list of available integrations, select Confluence.

4. Choose the appropriate action you want to perform. The available actions are detailed below:

Action	Description
Get page content	Retrieves the content of a specified Confluence page.
Create page from template	Creates a new page using a selected template.
Custom API call	Enables direct interaction with Confluence’s REST API.

How to create a Confluence connection in ZBrain Flow

To establish a connection between ZBrain Flow and Confluence:

1. Connection name: Enter a name for your connection for easy identification.

2. Account email: Provide the email address linked to your Atlassian account for basic authentication.

3. API token: Paste the API token you’ve obtained from Atlassian.

4. Confluence domain: Enter your Confluence domain (e.g., https://your-domain.atlassian.net). This is where ZBrain Flow will connect to interact with your Confluence instance.

Steps to get an API token from Atlassian:

1. Log in to your Atlassian account.

2. Under Security, click Create API token.

3. Give your API token a meaningful name that describes its purpose (e.g., “ZBrain Integration”).

4. Set an expiration date for the token, which can be from 1 day to 1 year.

5. Click Create.

6. Once created, click Copy to clipboard to save the token. Store it securely.

How to get page content

Configuration Options:

• Connection: Select an existing Confluence connection or create a new one. This defines the authenticated link between ZBrain Flow and your Confluence workspace.

• Page ID: Enter the unique identifier of the Confluence page you want to retrieve. You can find this ID in the URL of the page. For example, in https://yourdomain.atlassian.net/wiki/spaces/ABC/pages/123456789/Page+Title, the number 123456789 is the Page ID.

• Include descendants: Enable this option to fetch all child (nested) pages beneath the specified page. This is useful for retrieving full content hierarchies, such as an entire knowledge base section or documentation tree.

How to create a page from template

Configuration Options:

• Connection: Choose a valid Confluence connection from your list or configure a new one.

• Space: Select the Confluence space where the new page should reside. Spaces are content containers used to organize documentation by team, project, or function.

• Template: Choose from predefined templates available in the selected space. These templates often include formatted sections and placeholder variables to streamline content creation.

• Parent folder: Specify the parent page under which this new page will be created. This helps maintain a structured hierarchy within the space.

• Title: Enter the title for the new page. This will appear as the page name in Confluence.

• Status: Decide the visibility of the page upon creation:

  • Draft: Page is saved in draft mode and not visible to others until explicitly published.

  • Published: Page is live and immediately visible to users with access to the space.

How to Make a Custom API Call

Configuration Options:

• Connection: Select a previously saved Confluence connection or create a new one.

• URL: Provide either the full or relative URL of the REST API endpoint you wish to call. Example (relative path): /wiki/rest/api/content/{pageId} Example (full path): https://your-domain.atlassian.net/wiki/rest/api/content/123456789

• HTTP Method: Choose the appropriate HTTP method based on the action you want to perform:

  • GET – Retrieve data (e.g., read a page’s content).

  • POST – Create a new resource (e.g., create a page).

  • PUT – Replace existing content entirely.

  • PATCH – Partially update content (e.g., change title or body).

  • DELETE – Remove a resource (e.g., delete a page).

  • HEAD – Fetch only response headers, useful for debugging or checking availability.

• Headers: Add any required headers for the API call:

  • Authorization: Basic <base64-encoded-email:API-token> (Ensure the email and token are encoded correctly.)

  • Content-Type: Typically set to application/json for most requests.

Add multiple headers as required using the '+ Add Item' option.

• Query Parameters: Use query parameters to customize your request. Example: ?limit=10 to limit the number of returned results. Add multiple parameters as needed using the '+ Add Item' option.

• JSON Body: Required for methods like POST, PUT, or PATCH. The body defines what content or data is being sent to Confluence.

  Example Payload for a PATCH request:

  { "version": 2, "title": "Updated Page Title", "type": "page", "body": { "storage": { "value": "<h2>Updated Content</h2>", "representation": "storage" } } }

  Note: Always update the version number to one greater than the current version of the page to avoid conflicts.

• Timeout: Specify a timeout duration (in seconds). This limits how long the system waits for a response before stopping the request.