Connect Jira

One connector names one Jira Cloud site.

Jira Data Center and Jira Server are not supported.

Heplon can authenticate in two ways. Pick one before you start.

WayPick it when
OAuth client credentialsrecommended. Atlassian issues a new token every 60 minutes.
API tokenyou prefer one static token. It expires after at most 365 days.

You need the Organization admin role in Atlassian Administration.

1. Find the cloud ID

Sign in to admin.atlassian.com. In the sidebar, open Apps → Sites and select your Jira site.

The Apps section of the sidebar with Sites expanded and the site listed below it

The cloud ID is the string after /s/ in the address bar:

https://admin.atlassian.com/s/1a11d016-8984-4c3e-b9ab-142dd06acb1b/...
                              └──────────── cloud ID ────────────┘

The cloud ID is a UUID. Do not use the organization ID from admin.atlassian.com/o/....

2. Create the service account

In the sidebar, open Directory → Service accounts and select Create a service account.

The Service accounts page with the Create a service account button

Give it a name like heplon-docs and select Next.

The Name service account step with name and description filled in

On Select app roles, set the role of your Jira site to User. Leave every other app at None. Select Create.

The Select app roles step with the User role ticked for Jira

An organization gets 5 service accounts for free. More need Atlassian Guard.

3. Create the credential

Scopes

Both ways need the same two classic Jira scopes.

ScopeHeplon uses it to
read:jira-usercheck the credential (GET /rest/api/3/myself)
read:jira-workread projects, issues, and the comments on the issues

Create it

On the new service account, select Create credentials.

The Choose authentication type step with OAuth 2.0 and API token

Way 1: OAuth client credentials

  1. Select OAuth 2.0, then Next.
  2. Give the credential a name, for example heplon, and select Next.
  3. Search for read:jira- and tick the two scopes. Select Next, then Create.
The Select scopes step with read:jira-user and read:jira-work ticked

Copy the Client ID and the Client secret. Atlassian shows them once.

The Your OAuth credential page with the Client ID and Client secret fields and their copy buttons

Way 2: API token

  1. Select API token, then Next.
  2. Give the token a name and an expiry date, and select Next. The token lasts at most 365 days.
  3. Search for read:jira- and tick the two scopes. Select Next, then Create.
The Name API token step with name and expiry date

Copy the token. Atlassian shows it once.

4. Add the connector in Heplon

In Heplon, open Connectors.

The sidebar with Connectors selected under Administration

Select Add connector, in the top right.

The Relays, Access profiles, and Add connector buttons

Select Jira, under Work tracking.

The connector picker with Jira under Work tracking

Fill in the form.

FieldValue
Namean arbitrary name
Cloud IDfrom step 1
Authenticationthe way you picked in step 3
Client IDway 1 only: the client ID from step 3
Client secretway 1 only: the client secret from step 3
Tokenway 2 only: the API token from step 3
The Add Jira panel with Name, Cloud ID, OAuth client credentials, Client ID and Client secret filled in

With API token selected, the panel shows one Token field instead.

The Authentication section with API token selected and the Token field below it

Select Add connector. Heplon does not call Jira when you save.

5. Check the connector

The Connectors page checks every connector when it opens. The Jira card shows Healthy when Heplon reaches Jira with the credential.

A Jira connector card showing Healthy

Jira is now connected to Heplon.

If the check fails

MessageWhat to do
Jira found no site for this cloud id (HTTP 404)The cloud ID is wrong, or it is the organization ID. Repeat step 1.
Jira refused the service account (HTTP 403)The service account has no Jira role on this site. Give it the User role in Atlassian Administration (step 2).
Jira rejected the configured credential (HTTP 401)The API token expired or was revoked. Create a new credential and edit the connector.
could not get an Atlassian access tokenAtlassian refused the client ID or client secret. Check both, or create a new OAuth credential and edit the connector.
Jira rate limit exceeded (HTTP 429)Wait and reload the page.