Confluence

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Enabled by default.
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: read:confluence-content.all, write:confluence-content, read:confluence-space.summary, read:confluence-user, search:confluence, read:page:confluence, write:page:confluence, offline_access.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
ATLASSIAN_CLIENT_IDYesAtlassian OAuth Client ID (from your OAuth 2.0 app) Docs.
ATLASSIAN_CLIENT_SECRETYesAtlassian OAuth Client Secret Docs.
CONFLUENCE_CLOUD_IDNoOptional Atlassian site ID; required when the user can access multiple Confluence sites Docs.

Cloud access modes

Hosted Cloud tools support both user-delegated OAuth 2.0 authorization code access and application/service access using the OAuth 2.0 client credentials grant. These are separate credential configurations. The local Code runtime has its own supported authentication methods.

Set every application variable below in the target project environment. Delegated OAuth app variables above do not activate application access.

Application variableRequired
CONFLUENCE_SERVICE_ACCOUNT_CLIENT_IDYes
CONFLUENCE_SERVICE_ACCOUNT_CLIENT_SECRETYes
CONFLUENCE_SERVICE_ACCOUNT_CLOUD_IDYes

Configure application access describes provider setup, identity selection, project tool policy and supported-operation restrictions.

Setup

  1. Choose who owns the Atlassian OAuth app: On hosted Veryfront, Confluence uses the Veryfront-managed Atlassian OAuth app: connect Confluence from the project's integrations and approve the Atlassian consent screen, no environment variables needed. Set ATLASSIAN_CLIENT_ID and ATLASSIAN_CLIENT_SECRET only to use your own Atlassian OAuth app, which is required for local and self-hosted runs.
  2. Create an OAuth 2.0 integration: In the Atlassian developer console, create an OAuth 2.0 integration.
  3. Add the Confluence API permissions: Under Permissions, add the Confluence API and select these scopes: read:confluence-content.all, write:confluence-content, read:confluence-space.summary, read:confluence-user, search:confluence, read:page:confluence, write:page:confluence. offline_access is requested at authorization time so the connection can refresh its token.
  4. Add the callback URLs: Under Authorization, choose OAuth 2.0 (3LO). Add the redirect URI of the environment that completes the flow: https://api.veryfront.com/oauth/callback/confluence for hosted Veryfront, or your app origin followed by /api/auth/confluence/callback for a local or self-hosted app. Set ATLASSIAN_CLIENT_ID and ATLASSIAN_CLIENT_SECRET from the app's credentials.
  5. Share the app: Under Distribution, set the app to sharing so users outside your own Atlassian account can authorize it.
  6. Verify access: Run List Atlassian Sites (read-only) to find the site's cloud ID, then run Search Confluence (read-only) against that site. Neither call changes anything.

Provider notes

  • The connection requests read:confluence-content.all, write:confluence-content, read:confluence-space.summary, read:confluence-user, search:confluence, read:page:confluence, write:page:confluence and offline_access.
  • If the user can reach more than one Atlassian site, set CONFLUENCE_CLOUD_ID to the target site's cloud ID from List Atlassian Sites.
  • Tools that create, update, send or delete data are marked as writes and need write authority; the other tools are read-only.

Provider API reference.

Tools

ToolAccessDescription
List Atlassian Sites<br /><code className="reference-identifier">confluence__list_sites</code>ReadList Atlassian sites
Search Confluence<br /><code className="reference-identifier">confluence__search_content</code>ReadSearch Confluence
Get Page<br /><code className="reference-identifier">confluence__get_page</code>ReadGet page
Create Page<br /><code className="reference-identifier">confluence__create_page</code>WriteCreate page
Update Page<br /><code className="reference-identifier">confluence__update_page</code>WriteUpdate page
List Spaces<br /><code className="reference-identifier">confluence__list_spaces</code>ReadList spaces
Add Comment<br /><code className="reference-identifier">confluence__add_comment</code>WriteAdd comment

Verify the connection

Call a read tool such as confluence__list_sites with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.