Backbone Work Sync
5.24 5.23 5.22 5.21 5.20 Cloud Data Center
5.24 5.23 5.22 5.21 5.20 Cloud Data Center

Add Custom Request Headers for Jira Data Center

Some Jira Data Center instances sit behind a firewall or proxy. It only lets a request through if the request carries a specific HTTP header, such as a token.

Backbone Work Sync can add these headers to every request it sends from Jira Cloud to your Data Center instance. You set them once per Data Center instance, and every synchronization from your Cloud instance to that instance uses them.

Custom request headers apply to Cloud to Data Center synchronizations that you set up on Jira Cloud. Synchronizations set up on Data Center don't need them, because Data Center sends the requests.

Prerequisites

Before you begin, you need the following:

  • Jira admin permissions on your Jira Cloud instance.

  • The header names and values: your network or security team can tell you what the firewall or proxy expects.

  • The Data Center base URL: exactly as you use it in the synchronization, including any context path such as /jira.

Add Headers for a Data Center Instance

  1. Go to Apps > Backbone Work Sync > Global Settings.

  2. Under Custom request headers, select Add Data Center.

  3. Enter the Data Center base URL, then select Save.

  4. Select Add header.

  5. Enter the Header name and Value, then select Save.

  6. Repeat steps 4 and 5 for each header the firewall or proxy expects.

Changes take up to 3 minutes to take effect. Then create the synchronization as usual.

Edit or Remove Headers

You can change headers at any time:

  • Edit a header: select the header, change the name or value, then select Save.

  • Remove a header: select Remove header, then confirm.

  • Remove a Data Center: select Remove Data Center, then confirm. This removes all its headers.

Changes and removals take up to 3 minutes to apply.

Rules for URLs and Headers

Backbone checks each entry when you save it. The table below lists the rules.

Item

Rule

Data Center base URL

Starts with http:// or https://. Contains no ? or #. Must match the URL your synchronization uses, including any context path. Case, a trailing slash, and the default port don't matter.

Header name

A valid HTTP header name, used once per Data Center.

Header value

Up to 4,096 characters. No spaces at the start or end, and no line breaks.

You can't add headers that Backbone sets itself: Authorization, Proxy-Authorization, Cookie, Host, User-Agent, Content-Type, Content-Length, Transfer-Encoding, Connection, Date, Expect, From, Upgrade, Via, and Warning.

Things to Know

Keep the following in mind:

  • Your browser connects directly: when you authorize the connection, your browser opens the Data Center instance itself, without custom headers. Make sure you can reach the instance from your browser.

  • Values stay visible: anyone who can open the Backbone Work Sync global settings can see header values. Use a token created for Backbone Work Sync, so you can replace it without affecting other systems.

  • The instance must still be reachable: headers let your firewall recognize Backbone Work Sync. They don't replace a route from the internet to your Data Center instance.

Last updated: