# Confluence Embed Macro

> **Note**
>
> This Confluence app works alongside the [Hub](https://marketplace.atlassian.com/apps/1230872/released-feedback-portal-public-roadmap-ai-release-notes?hosting=cloud\&tab=overview) app for Jira. To use it, Hub must be installed in Jira. The credentials below are generated and managed within the Jira app.

## Installation

### Navigate to the Atlassian Marketplace

[https://marketplace.atlassian.com/apps/3830961120](https://marketplace.atlassian.com/apps/3830961120)

### Install the App

- Click **Install** or **Try it free**
- Review the permissions requested by the app
- Click **Accept & install**

### Verify Installation

- The app is now available in all Confluence pages
- You can start using the Hub Embed macro immediately

***

## Using the Macro

### Edit a Confluence Page

- Navigate to the page where you want to embed your Hub portal
- Click **Edit** in the top right

### Insert the Hub Embed Macro

- Type `/` to open the quick insert menu
- Type "Hub" and select **Hub Embed** from the list
- Or use the toolbar: Click **+** → Search for "Hub Embed"

### Configure the Macro

- A configuration dialog will appear
- Find the [**Channel ID**](/guide/resources/how-tos/finding-the-channel-id/) within the Hub app in Jira. You can find the channel ID on the [**Page** Embed](/guide/product/portals/portal/announcement-page/) settings in your workspace
- Optionally configure additional settings

| Setting           | Description                                                                                 | Required          |
| ----------------- | ------------------------------------------------------------------------------------------- | ----------------- |
| **Channel ID**    | Your Hub channel identifier. [Learn more](/guide/resources/how-tos/finding-the-channel-id/) | ✅ Yes             |
| **Module**        | Choose what to display: `Changelog`, `Roadmap`, or `All`                                    | No (default: All) |
| **Show Header**   | Toggle header visibility                                                                    | No (default: Off) |
| **Primary Color** | Custom hex color code (e.g., `#6514DD`)                                                     | No                |

### Review the Preview

- The macro will show a preview in the editor
- If you don't have a valid Channel ID, you'll see an empty state message

### Save and Publish

- Click **Publish** in the top right
- Your Hub portal is now live on the Confluence page

***

## User Verification Setup

User verification enables personalized portal experiences for your Confluence users, allowing them to see content tailored to their profile and permissions.

### Prerequisites

To enable user verification for your Confluence macro you will require your Hub **Account ID** and **Shared Secret** which can be found under [#credentials](/guide/product/administration/user-verification/#credentials-and-responsibilities "mention") within the **Hub app in Jira.**

### Configure in Confluence

### Access Global Settings

- Click the **Settings** icon (⚙️) in Confluence
- Scroll down to **Atlassian Marketplace** section
- Click **Hub Portals**

### Enable User Verification

Toggle **Enable User Verification** to ON

### Enter Your Credentials

- **Account ID**: Paste your Hub account ID
- **Shared Secret**: Paste your shared secret

The system will automatically save and test the connection. If the connection fails, double-check your credentials

### Add Trusted Domain

- After successful authentication, you'll see a **Trusted Domain Required** section
- Copy the displayed Forge domain (e.g., `https://xxxxxxxx.confluence-connect.com`)
- Add this domain to your [**Trusted Domains**](/guide/product/administration/trusted-domains/) in the Hub app in Jira.

📖 **Learn more:** [Trusted Domains Configuration](/guide/product/administration/trusted-domains/)

### How It Works

Once configured:

1. **Automatic Authentication**
   - When a Confluence user views a page with the Hub macro, they're automatically authenticated
   - No additional login required
2. **Personalized Content**
   - Users see content based on their Released.so permissions
   - Feedback submissions, upvotes, and comments are tied to their identity
3. **Profile Sync**
   - User's Confluence display name and avatar are synced to Hub
   - Ensures consistent identity across platforms

### Security Notes

- The **Shared Secret** is stored securely using Forge's encrypted storage
- User emails are only accessed when User Verification is enabled
- Data is transmitted over HTTPS to Released.so's authentication API
- Only the current user's own data is shared (no access to other users' data)

***

### Troubleshooting

Macro Doesn't Load

**Symptom:** The macro shows an empty state or doesn't display content

**Solutions:**

1. **Verify Channel ID**
   - Ensure your Channel ID is in the correct UUID format
   - Check for typos or extra spaces
   - Get the correct ID from Released.so → Settings → Integrations
2. **Check Trusted Domains**
   - Open your browser's developer console (F12)
   - Look for the warning: `[Hub] If the embed does not load...`
   - Add your Confluence domain to Trusted Domains in Released.so
3. **Clear Browser Cache**
   - Hard refresh the page (Ctrl/Cmd + Shift + R)
   - Clear your browser cache and cookies

User Verification Not Working

**Symptom:** Users see "Email API access required" error

**Solutions:**

1. **Verify Credentials**
   - Go to Hub Portals global settings in Confluence
   - Re-enter your Account ID and Shared Secret
   - Ensure the connection status shows "Authentication successful"
2. **Check Trusted Domains**
   - Verify the Forge domain is added to Released.so
   - The domain should match exactly (including `https://`)
3. **Email Access Permissions**
   - The app requires the `read:email-address:confluence` scope
   - This should be granted automatically during installation
   - If issues persist, try reinstalling the app

Configuration Not Saving

**Symptom:** Macro configuration doesn't persist

**Solutions:**

1. **Invalid Channel ID**
   - Ensure the Channel ID is a valid UUID format
   - The configuration dialog will show a red X if invalid
2. **Browser Issues**
   - Try a different browser
   - Disable browser extensions that might interfere
3. **Confluence Permissions**
   - Ensure you have edit permissions on the page
   - Check with your Confluence administrator

### Support

Need help? We're here for you. Contact us at [released.so/support](https://released.so/support)