Sync Bridge for Jira Cloud
Sync Bridge for Jira Cloud
Breadcrumbs

Installation Guide

📘 What you will learn here

On this page you will learn how to install Sync Bridge for Jira Cloud, prepare the other Jira Cloud site, and what happens when your license expires.

✅ Prerequisites

You must be:

  • Logged in as a Jira administrator of the Jira Cloud site where you install the app. The Sync Bridge admin page is only shown to Jira administrators.

You also need:

Install Sync Bridge on one Jira Cloud site only. In the app, that site is called This Jira site. The other site doesn't need the app: Sync Bridge reaches it through a connector.

🛠️ Guide

  1. Go to ⚙️ Settings > Apps, or Apps > Manage your apps.

  2. Click Find new apps.

  3. Search for Sync Bridge.

  4. Click the app, then click Try it free.

  5. Review the permissions the app requests, then click Start free trial.

  6. The app is installed and available.

Sync Bridge is displayed under Settings > Apps. Continue with Getting Started to set up your first sync.

📍 Find the app after installation

Where

What you'll find

Who sees it

Settings > Apps > Sync Bridge

The admin page with Dashboard, Connectors, Sync rules and Sync history.

Jira administrators

The Sync Bridge panel on a work item

Sync status for each sync rule, and actions such as push, pull and retry. See Sync Bridge panel.

Anyone who can browse the work item. Push, pull and retry are for Jira administrators.

The Sync history tab in a work item's activity

Every sync of that work item. See Sync History tab.

Anyone who can browse the work item

🔐 Permissions the app requests

During installation, Jira shows the permissions Sync Bridge needs on This Jira site. They are used as follows.

Permission (scope)

Why Sync Bridge needs it

read:jira-work

Read work items, comments, attachments, fields and statuses so they can be pushed to the other site.

write:jira-work

Update work items, change their status, and add comments and attachments when data is pulled from the other site.

manage:jira-project and manage:jira-configuration

Read the space and site configuration that sync rules depend on, such as spaces, work types, workflows and statuses.

read:jira-user

Look up people and groups, for example in comment and attachment filters, user fields and per-work-item sync permissions.

read:issue.property:jira and write:issue.property:jira

Store each work item's sync status on the work item itself. This powers the Sync Bridge panel and lets you search synced work items with JQL.

storage:app

Store connectors, sync rules, links between work items and sync history in the app's storage on Atlassian's platform.

Sync Bridge is built on Atlassian Forge. Its outbound connections are limited to Atlassian Cloud addresses (*.atlassian.net and *.atlassian.com). The *.atlassian.com address is needed to download attachments from the other site.

Connector credentials (email and API token) are stored as encrypted secrets in the app's storage. When you edit a connector, the saved API token is never shown again.

🌐 Prepare the other site

Sync Bridge connects to the other Jira Cloud site with an email address and an API token. Prepare this before you add a connector.

  1. Choose the account Sync Bridge will use on the other site. Work items, comments and attachments created on that site appear as created by this account, so a dedicated account is a good idea.

  2. Make sure the account can work in every space you want to sync: browse and create work items, edit them, transition them, and add or delete comments and attachments.

  3. Give the account Jira administrator permissions on the other site. When you test a connector, Sync Bridge warns you if the account isn't a Jira administrator, because some features, like loading spaces and workflows, won't work without it.

  4. Sign in to id.atlassian.com/manage-profile/security/api-tokens as that account and create an API token. The connector form also has a Create an API token link.

  5. Note the site URL, for example https://your-site.atlassian.net.

If the API token expires or is revoked, syncs to that site fail with an authentication error until you enter a new token in the connector.

🧪 Free trial

  • During a trial you can add up to 2 connectors and 3 sync rules. Upgrade to add more.

  • A banner at the top of the admin page shows how many trial days are left, with a Manage license link. In the last 3 days the banner is highlighted.

⏳ Licenses expiration behavior

Licenses have expiration dates. When your trial ends or your license becomes inactive, Sync Bridge stops syncing, and the admin page shows: "Your Sync Bridge license is inactive, so syncing and editing are paused. Renew your license to resume." That means:

  • No new syncs start. Jira events are ignored, scheduled pulls don't run, and syncs that were already waiting are dropped.

  • The Sync Trigger API returns 402 with the message "The Sync Bridge license for this site is inactive."

  • In the Sync Bridge panel, push, pull, retry and the per-work-item sync switch are disabled.

  • Connectors, sync rules and API tokens can't be created or changed. Testing connectors, importing sync rules and the smart value preview are also unavailable.

  • Your data is preserved: connectors, sync rules, links between work items and sync history are kept.

While the license is inactive, you can still:

  • Open the admin page and view the dashboard, connectors, sync rules and Sync history.

  • See sync status and Sync history on work items.

  • Export sync rules, delete connectors and sync rules, unlink work items and revoke API tokens.

The daily Sync history cleanup also keeps running, based on your retention setting.

After you renew: syncing resumes automatically, with no setup needed. Scheduled pulls pick up the changes made on the other site while the license was inactive. Changes made on This Jira site during that time are pushed the next time each work item syncs, for example on its next update, a manual push, or an API call.

➡️ Next steps