Atlassian Connector for Jira & Confluence Data Center

The Atlassian Connector for Jira & Confluence Data Center indexes:

• Projects, issues, comments, and attachments across your Jira instance.
• Spaces, pages, blog posts, comments, and attachments across your Confluence instance.
• Users and groups in Jira & Confluence for the purpose of understanding permissions.

The connectors authenticate to Jira and Confluence as a dedicated service user using a Personal Access Token (PAT). They run as part of your Atolio deployment — no plugin or app needs to be installed in Jira or Confluence.

Note: Earlier releases of this connector shipped as Atlassian SDK plugins (jira-dc-connector-*.jar and confluence-dc-connector-*.jar) installed via Manage apps. Clients are encouraged to migrate to the new connectors described below.

Create a Service User

In each of Jira DC and Confluence DC, create a dedicated user for Atolio to authenticate as (for example, atolio-connector-user).

You have two options for the permission scope you grant this user:

Option 1 — Administrator access (recommended for easy setup). Grant the service user administrator membership:

• In Jira, add the user to the Jira Administrators group (or an equivalent admin role).
• In Confluence, add the user to the Confluence Administrators group (or grant System Administrator).

With admin access, the connector automatically registers the webhook it needs for live updates on startup. No further setup is required in Jira or Confluence.

Option 2 — Read-only access. Grant the service user only the permissions required to read the content you want indexed:

• In Jira, grant Browse Projects on every project to be indexed (the easiest way is to add the user to the default permission scheme).
• In Confluence, grant View permission on every space to be indexed (the easiest way is to add the user to the default space permission scheme).

Read-only access means the connector cannot register its own webhook. You can either:

• Skip webhook registration entirely — the connector will still backfill and periodically resync, but changes in Jira and Confluence will not be reflected live, or
• Register the webhook manually (see Manual Webhook Setup below).

Create a Personal Access Token

For each of Jira and Confluence:

1. Log in as the service user.
2. Go to Profile → Personal Access Tokens → Create token.
3. Give the token a name (e.g. atolio-connector-token) and set an expiry if required by your policy.
4. Copy the token. You’ll provide it as described in Required Configuration Values.

Required Configuration Values

Enter these values in the Atolio Admin console (v4.24 and later), or send them to Atolio Support (your Deployment Engineer).

Provide one set of values for each connector instance (Jira and Confluence are configured separately).

You can optionally restrict indexing to specific projects (Jira) or spaces (Confluence) via the resources field — see Common Fields: Resources.

Provided by Atolio: the callbackBaseURL, used for Manual Webhook Setup.

Keep secrets secure: Share values marked “Yes” in the Secret column only through a password-manager share (e.g. 1Password) or another secure channel agreed with Atolio Support. Never send them in plain email, chat, or support tickets.

Configuration Example

Add this block to connector-values.yaml. Replace each <PLACEHOLDER> with the matching value from the table above, and remove any line marked “Only if” that doesn’t apply.

connectors:
  jiradc:  # Only if indexing Jira
    default:
      jiradc:
        connector: jiradc
        instance: default
        source: jiradc
        common:
          enabled: true
          identity-provider: false
        secrets:
          personal_access_token:
            value: "<JIRA_PERSONAL_ACCESS_TOKEN>"
        configuration:
          base-url: "<JIRA_BASE_URL>"
          disable-webhook-registration: true  # Only if the service user is read-only or you manage the webhook yourself
  confluencedc:  # Only if indexing Confluence
    default:
      confluencedc:
        connector: confluencedc
        instance: default
        source: confluencedc
        common:
          enabled: true
          identity-provider: false
        secrets:
          personal_access_token:
            value: "<CONFLUENCE_PERSONAL_ACCESS_TOKEN>"
        configuration:
          base-url: "<CONFLUENCE_BASE_URL>"
          disable-webhook-registration: true  # Only if the service user is read-only or you manage the webhook yourself

If you remove the jiradc or confluencedc line, remove everything indented under it too.

Manual Webhook Setup

If the service user does not have admin permissions, or if you prefer to manage webhooks yourself, register the webhook manually after the connector is running. Set disable-webhook-registration: true in the connector configuration to prevent the connector from attempting to register one.

Jira

1. In Jira, go to Administration → System → WebHooks → Create a WebHook.
2. Set the URL to {callbackBaseURL}/connectors/jiradc/{instance}/callback, where {instance} is the connector instance name (e.g. default). Your Deployment Engineer can provide the correct callbackBaseURL.
3. Enable the following events:
   • jira:issue_created, jira:issue_updated, jira:issue_deleted
   • comment_created, comment_updated, comment_deleted
   • project_created, project_updated, project_deleted

Confluence

1. In Confluence, go to Administration → General Configuration → Webhook → Create webhook.
2. Set the URL to {callbackBaseURL}/connectors/confluencedc/{instance}/callback, where {instance} is the connector instance name (e.g. default). Your Deployment Engineer can provide the correct callbackBaseURL.
3. Enable the following events:
   • page_created, page_updated, page_removed, page_trashed, page_restored
   • blog_created, blog_updated, blog_removed, blog_trashed, blog_restored
   • comment_created, comment_updated, comment_removed
   • space_created, space_updated, space_removed