Skip to main content

Atlassian Integration Setup with nOps Essentials

To integrate Atlassian with nOps Essentials, follow these steps:

  1. Create an API Key in Atlassian
  2. Set Up Integration in nOps Platform
  3. Verify Integration

Prerequisites​

Before setting up the integration, ensure you have:

  1. Atlassian Account

    • Active Atlassian account with admin access
    • Permission to create API keys

  2. Required Permissions

    • Ability to create API keys with usage data access
    • Permission to view organization settings

  3. Required Information

    • Atlassian API key with appropriate permissions
    • Understanding of which Atlassian services you want to track

Accessing Essentials Integrations​

To begin, navigate to the Organization Settings and click on Integrations. From there, select Essentials to proceed with setting up your Atlassian integration.

Below is an example of the integrations page:
Essentials Integrations Interface

This page provides access to configure and manage integrations with your Essentials tools.

The list of integrations will indicate whether there are any active integrations or if the tools are not yet integrated. Active integrations will be marked accordingly, allowing you to easily identify the current status of each integration.

How the Integration Works​

  1. API Key Creation

    • Create an API key in the Atlassian platform with read-only permissions
    • Securely store and provide this key to nOps during integration setup

  2. Integration Setup

    • Enter a descriptive API Key Name for identification purposes
    • Configure the Atlassian API Key in nOps
    • Set an optional expiration date for your API key (up to 1 year)
    note

    Make sure to keep your API key secure and never share it with unauthorized users.

  3. Data Retrieval by nOps

    • nOps uses the provided API key to fetch usage and user activity data from Atlassian
    • Data is collected for all services associated with your Atlassian account

  4. Data Processing

    • The retrieved data is processed and displayed within the Essentials product
    • Usage information is organized by product, user activity, and time period

Step 1: Create an API Key in Atlassian​

API keys are required for secure access to your Atlassian usage and user activity data.

  1. Access API Key Settings

    • Log in to your Atlassian account
    • Navigate to the API Key settings in your Atlassian account clicking on Settings on top and then API keys on the left menu.
    • Click on Create API Key

  2. Set API Key Parameters

    • Select API key with scopes
    • Enter a descriptive name (e.g., "nOps Integration")
    • Select all Read permissions for usage and user activity data access
    • Set an expiration date
    • Click Next and then Create API key
    important

    When this expires you will need to update it in the platform - Atlassian requires to set an expiration date on each API key.

  3. Save API Key

    • Copy the generated API key
    • Store it securely—API keys are typically shown only once
    caution

    Do not share your API key or expose it in public repositories. If the API key is lost, you'll need to generate a new one and update the integration.

Step 2: Set Up Integration in nOps​

  1. Access the Essentials Integrations page in your nOps account to begin.
  2. Select the Atlassian integration card.
  3. Click on the +Add Atlassian Integration button

Configuration Parameters​

  1. Enter API Key Name

    • Provide a descriptive name for this integration (e.g., "Engineering Team Atlassian" or "Marketing Atlassian")
    • This helps identify the integration if you have multiple Atlassian accounts

  2. Enter API Key

    • Paste the API key you copied from the Atlassian platform

  3. Set Expiration Date (Optional)

    • Select an expiration date for the integration
    • The maximum allowed period is 1 year from the current date
    • If not specified, the integration will use a default expiration of 1 year

  4. Click Setup to finish

    important

    Double-check your API key. Incorrect entries will prevent synchronization.

Managing Multiple Integrations​

If you need to track usage for multiple Atlassian accounts or projects:

  1. Create Separate API Keys

    • Generate a unique API key for each Atlassian account
    • Ensure each key has the appropriate permissions

  2. Set Up Additional Integrations

    • Follow the same process to add each integration
    • Use distinct, descriptive names for each integration to easily identify them

Troubleshooting​

  1. API Key Issues

    • Verify the key has not expired
    • Ensure it has read permissions for usage and user activity data
    • Check for typos in the API key

  2. Data Not Appearing

    • Allow up to 24 hours after setup
    • Confirm there is actual user activity in your Atlassian account
    • Verify the API key is still active in Atlassian

  3. Incomplete Data

    • Ensure the API key has access to all relevant Atlassian services
    • Check if there are any usage limits on your Atlassian account

For support, contact nOps with your API Key Name (not the actual key) and any error messages you've encountered.