Confluence sync plugin
Install the Archbee app on your Confluence site, and every page you publish in a synced space shows up in Archbee within seconds.
Before you start
- You are an admin of your Confluence site. A space admin cannot install apps.
- You can open Settings in your Archbee organization.
If your Archbee organization is in Europe, use eu.app.archbee.com wherever this guide says app.archbee.com.
Install the app
- Open the installation link. The app is not on the Atlassian Marketplace, so this link is the only way to install it.
- Click Get app, choose your Confluence site, and approve the permissions. The page lists three: Read Confluence content summary, App Storage scope, and Share data with 2 domains outside of Atlassian. The two domains are api.archbee.com and eu.api.archbee.com. The app sends them page IDs, never page content.
Installing the app does not sync anything yet. To check that it is installed, look for Archbee in the list of connected apps. You can open that list in two ways:
- In Confluence, open the Apps menu and click Manage your apps.
- At admin.atlassian.com, choose your organization. In the left sidebar, open Apps, then Sites, then your site, and click Connected apps.
Let Archbee read your pages
Archbee fetches the page content itself, with an Atlassian API token you give it.
- Create an Atlassian API token at id.atlassian.com/manage-profile/security/api-tokens. Click Create API token, not "Create API token with scopes". Copy the token right away, because Atlassian shows it only once.
- Add the token to Archbee. Open app.archbee.com/settings/team-integrations and choose Confluence. Enter your Atlassian account email in the Username field and paste the token.
- Import your Confluence space. In Archbee, create a new empty doc, click Sync from other apps, then Confluence, and paste the URL of your Confluence space. You import a space once. The app keeps the imported pages in sync after that, and pages you never imported do not sync.
Turn on sync for the space
An Archbee API key tells the app which Archbee organization the pages belong to.
- Create an organization API key at app.archbee.com/settings/organization-api-key with read and write access. Archbee refuses read-only keys. Name it "Confluence sync" so you can tell it apart from your other keys.
- Open Archbee sync in Confluence. Go to the space you imported and open Space settings, then Integrations (scroll down in the left nav), then Archbee sync.
- Pick the region, paste the key, and save. Under Archbee region, choose where your Archbee organization lives: United States or Europe. Paste the key into Archbee API key and click Save.
A key works only in its own region. Repeat steps 2 and 3 for each space you want to sync.
Check that it works
Wait one minute after saving the settings. Then edit a page in the synced space and click Update. The doc in Archbee changes within about 20 seconds, without a reload.
Good to know
- A classic page reaches Archbee a few seconds after you publish it. A live doc reaches Archbee about 8 minutes after the editing session ends.
- A page you create under a synced page shows up in Archbee as a new doc.
- Deleting a page in Confluence does not delete its doc in Archbee.
- To stop syncing a space, open Archbee sync in the space settings and click Turn sync off. This removes the key from the space.
- If an edit does not show up in Archbee, check that the page was imported, that the key has read and write access, that the region matches your Archbee organization, and that the email and token in the Confluence settings in Archbee are correct.