Skip to main content

Atlassian Compass

Atlassian Compass is a developer experience platform that catalogs the components, services, and teams that make up your software architecture. The Nexla connector uses the Compass REST API to pull operational alert data — alerts, notes, activity logs, and component attachments — as a data source, and to push component events, metric values, and file, API-spec, and dependency attachments as a destination. Authentication uses HTTP Basic Auth with an Atlassian account email and API token, scoped to your Atlassian Cloud site.

Atlassian Compass icon

Power end-to-end data operations for your Atlassian Compass API with Nexla. Our bi-directional Atlassian Compass connector is purpose-built for Atlassian Compass, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Atlassian Compass or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Atlassian Compass workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Before creating an Atlassian Compass credential, you need an Atlassian account with access to the Compass site, an API token for that account, and the Cloud ID and site domain of your Atlassian Cloud site. The Compass REST API uses HTTP Basic Auth, sending your Atlassian account email as the username and the API token as the password.

To gather these credentials, follow these steps:

  1. Sign in to your Atlassian account that has access to the Compass site.

  2. Navigate to https://id.atlassian.com/manage-profile/security/api-tokens to open the API tokens page.

  3. Click Create API token, give the token a descriptive name, and choose an expiration date (Atlassian allows 1 to 365 days).

  4. Click Create, then copy the token value immediately and store it securely. Atlassian shows the token only once and it cannot be retrieved later.

  5. Note the email address of the Atlassian account you used — this is the Basic Auth username that pairs with the API token.

  6. Find your Cloud ID by visiting https://your-site.atlassian.net/_edge/tenant_info in a browser (replace your-site with your site name). The page returns a JSON response containing your cloudId. No authentication is required to retrieve it.

  7. Note your Atlassian site domain (for example, yourcompany.atlassian.net). Compass Ops/Alerts requests are scoped by Cloud ID, while the Events, Metrics, and Attachments endpoints address your site domain directly.

For more detail, see the Atlassian API token documentation and the Compass REST API reference.

Authenticate​

Credentials required​

FieldRequiredSecretDescription
Atlassian Account EmailYesNoThe email address of the Atlassian account used to generate the API token.
API TokenYesYesAPI token generated from https://id.atlassian.com/manage/api-tokens, used as the Basic Auth password.
Cloud IDYesNoThe Atlassian cloud ID for the site running Compass, used to scope every Ops/Alerts request (https://api.atlassian.com/compass/cloud/{cloud_id}/ops/...).
Atlassian Site DomainYesNoYour Atlassian Cloud site domain (e.g. yourcompany.atlassian.net). Events/Metrics/Attachments use this domain directly; Ops/Alerts is scoped by cloudId instead.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the Atlassian Account Email for the account that generated the API token.

  4. Enter the API Token you created in Prerequisites. This value is used as the Basic Auth password and must be kept confidential.

  5. Enter the Cloud ID of the Atlassian site running Compass, and the Atlassian Site Domain (for example, yourcompany.atlassian.net).

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Atlassian Compass connector tile, then select the credential that will be used to connect to Compass, and click Next; or, create a new Atlassian Compass credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Atlassian Compass endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Alerts

Retrieves the list of alerts for the Compass cloud instance, including alert id, message, status, priority, tags, and responders.

  • This endpoint is paginated; Nexla automatically follows the pagination to retrieve subsequent pages of alert records.

[Rest API] Get Alert

Retrieves the full detail of a single alert by id.

  • Provide the Alert ID (the Compass/Ops alert id or tiny id) to retrieve.

[Rest API] Alert Notes

Retrieves the notes recorded against a specific alert, useful for tracking investigation/response history.

  • Provide the Alert ID whose notes are retrieved.

[Rest API] Alert Activity Logs

Retrieves the activity/audit log entries for a specific alert (status changes, acknowledgements, escalations, etc).

  • Provide the Alert ID whose activity log is retrieved.

[Rest API] Get Component Attachment

Retrieves metadata (name, url, lastModifiedAt) for a file attached to a Compass component by a Forge app.

  • Provide the Component ID the attachment belongs to, the Forge App ID that owns the attachment, and the Attachment Key.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Atlassian Compass data sources can also be manually configured to ingest data from any valid Compass REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Atlassian Compass data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Atlassian Compass destination, and select the Send to Destination option from the menu. Select the Atlassian Compass connector from the list of available destination connectors, then select the credential that will be used to connect to Compass, and click Next; or, create a new Atlassian Compass credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Atlassian Compass endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Alert

Creates a new alert in the Compass cloud instance. The request body is the alert creation payload (message, description, priority, responders, tags, etc).

  • Each record from your Nexset is sent as a separate API request to create an alert.

[Rest API] Acknowledge Alert

Acknowledges an existing alert.

  • Provide the Alert ID of the alert to acknowledge.

[Rest API] Close Alert

Closes an existing alert.

  • Provide the Alert ID of the alert to close.

[Rest API] Add Alert Note

Adds a note to an existing alert.

  • Provide the Alert ID of the alert to annotate.

[Rest API] Update Alert Priority

Updates the priority of an existing alert.

  • Provide the Alert ID of the alert to update.

[Rest API] Create Component Event

Sends a Compass event (deployment, build, incident, flag, alert, lifecycle, custom, push, pullRequest, or vulnerability) tied to a component.

  • The request body must include the cloudId, event, and componentId.

[Rest API] Push Component Metric Value

Sends a metric value into a component's connected metric source.

  • The request body includes the title, value, timestamp, metricDefinitionId, and componentId.

[Rest API] Attach Component File

Attaches (uploads) a file to a Compass component via a Forge app.

  • Provide the Component ID to attach the file to, the Forge App ID that owns the attachment, and the Attachment Key.

[Rest API] Upload Component API Spec

Uploads an API specification file for a Compass component.

  • Provide the Component ID the API spec belongs to.

[Rest API] Upload Package Dependencies

Uploads a package-dependencies lock file for a component from a given source.

  • Provide the Component ID the dependencies belong to, the Source ID of the dependency source, and the Base Source URL of the source repository.

Manual configuration​

Atlassian Compass destinations can also be manually configured to send data to any valid Compass REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Atlassian Compass endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Atlassian Compass endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.