Atlassian Integration

The Release Cadence Atlassian integration connects your product management workflow to Jira and Confluence. Requirements status surfaces directly in the Confluence page byline, and customer survey data appears on Jira Epics and JPD Ideas — automatically, without switching tools.

Pro Plan required. The Atlassian integration (Jira, Confluence, and JPD) is available on the Pro plan only. View pricing →

What It Does

The integration adds two modules to your Atlassian workspace:

  • Requirements Status (Confluence): A byline item that appears below the title of every Confluence page. When a design document has been pushed from Release Cadence, the byline shows the linked project's checkpoint status — whether the document is up to date with the latest requirements checkpoint or a newer one is available.
  • Customer Voice (Jira): An issue panel that appears on Jira Epics and JPD Ideas linked to Release Cadence features. It shows aggregated customer survey data — NPS scores, response distributions, open-ended answers — without leaving Jira.

Note: Configuration is shared across Confluence and Jira. Setting it up in one place configures both. You only need to enter your API key once.

Prerequisites

  • A Release Cadence account — sign up here if you don't have one
  • Jira Cloud and/or Confluence Cloud (the integration does not support Server or Data Center)
  • Space admin access in Confluence, or Jira admin access — required only to configure the integration; regular users can view the panels without admin rights

Step 1 — Install from the Atlassian Marketplace

  1. Go to the Atlassian Marketplace and search for Release Cadence
  2. Click Get it now and select your Atlassian site
  3. Confirm the installation — the app is free

Once installed, the Customer Voice panel will appear on all Jira issues and the Requirements Status item will appear in the Confluence page byline. Both will show a "not configured" message until you complete setup.

Step 2 — Generate an API Key in Release Cadence

  1. Sign in to app.releasecadence.dev
  2. Go to Organization Settings → API Keys
  3. Click Generate New Key
  4. Give the key a name (e.g. "Atlassian Integration") and click Create
  5. Copy the key — it starts with rc_ and is shown only once

Important: Copy the API key before closing the dialog. It cannot be retrieved again. If you lose it, generate a new one and update your Atlassian configuration.

Step 3 — Configure in Confluence (Recommended)

Configuration through Confluence Space Settings is the recommended approach. It applies to your entire Atlassian site — you don't need to repeat it in Jira.

  1. Open any Confluence space
  2. Go to Space Settings (bottom-left sidebar)
  3. Under Apps, click Release Cadence
  4. Paste your API key into the API Key field
  5. Leave Platform API URL blank (it defaults to https://api.releasecadence.dev)
  6. Click Test Connection — you should see your organization name confirmed
  7. Click Save

Configuration is complete. The Requirements Status byline will now activate on pages linked to Release Cadence projects, and the Customer Voice panel will activate on Jira issues linked to Release Cadence features.

Step 3 (Alternative) — Configure in Jira

If you prefer to configure through Jira, or you only have Jira (not Confluence):

  1. In Jira, go to Apps in the top navigation
  2. Click Release Cadence Setup
  3. Paste your API key and click Save Configuration

This stores the same configuration. If you've already configured through Confluence, the Jira page will show the existing key prefix and you don't need to do anything.

Using Requirements Status in Confluence

How pages get linked

The byline activates automatically when a design document is pushed to Confluence from Release Cadence. You don't need to manually link pages.

To push a design document:

  1. Open a project in Release Cadence
  2. Go to the Design Documents tab
  3. Click Push to Confluence on the document you want to publish
  4. Select the target Confluence space and page location
  5. Confirm — Release Cadence creates or updates the page and links it to the project automatically

After the push completes, reload the Confluence page. The byline will show the project's requirements status.

What the byline shows

  • Up to date: The design doc reflects the latest requirements checkpoint. The date of that checkpoint is shown.
  • Newer checkpoint available: A requirements checkpoint has been committed in Release Cadence since this design doc was last pushed. Push the document again to bring it up to date.
  • No checkpoints yet: The project exists in Release Cadence but no requirements checkpoint has been committed yet.
  • Requirements status will appear here once a design doc is pushed: This page has not been pushed from Release Cadence. It will show on all Confluence pages — only pages with a pushed design doc show live data.

Viewing the full project

The byline includes a View in Release Cadence → link that takes you directly to the project's requirements page.

Using Customer Voice in Jira

How issues get linked

The Customer Voice panel shows data for Jira Epics and JPD Ideas that are linked to Release Cadence features. A link is created when you connect a feature to a Jira issue from within Release Cadence:

  1. Open a feature in Release Cadence
  2. Go to Integrations → Atlassian
  3. Select the Jira project and search for the Epic or Idea to link
  4. Confirm the link

The Customer Voice panel on that Jira issue will now show survey data for the linked feature.

What the panel shows

For each survey linked to the feature, the panel shows:

  • Survey title and status (Active, Draft, Closed)
  • Total response count
  • Per-question analytics:
    • NPS: Score, average, and response distribution
    • Rating / Likert / Number: Average and bar chart distribution
    • Single / Multi select / Dropdown: Option counts and percentages (pie chart for ≤5 options)
    • Yes / No: Yes/no split with percentages
    • Text: Common word frequency and sample responses

The panel includes a View in Release Cadence → link to open the full feature page where you can see all surveys, create new ones, and manage feedback.

Note: The Customer Voice panel appears on all Jira issues. On issues not linked to a Release Cadence feature, it shows "This idea is not linked to a Release Cadence feature" — this is expected behavior.

Troubleshooting

The byline or panel says "not configured"

The API key has not been saved yet. A Confluence space admin should complete Step 3 above. If configuration was already saved but you're still seeing this, try re-entering the API key in Space Settings and clicking Test Connection to verify it's valid.

"API key is invalid or revoked"

The API key stored in the integration no longer works. Generate a new key in Release Cadence (Organization Settings → API Keys) and update the Space Settings configuration.

The byline shows "requirements status will appear here once a design doc is pushed" on a page I already pushed

This can happen if the page was pushed while the integration was not yet configured, or if the Forge app's cached page-to-project mapping is stale. Try pushing the document again from Release Cadence — this refreshes the link. If the issue persists, contact support.

The Customer Voice panel shows no surveys

The Jira issue is linked to a Release Cadence feature, but no surveys have been created for that feature yet. Create a survey in Release Cadence and link it to the feature — it will appear in the panel once at least one response has been collected.

Configuration saved but changes aren't appearing

The Forge app caches some data to improve performance. Try a hard refresh (Cmd+Shift+R on Mac, Ctrl+Shift+R on Windows) on the Confluence or Jira page. If the issue persists after a few minutes, contact support.

Need Help?

← Back to Documentation See also: Jira Workflow →