# Compass

**URL:** https://community.developer.atlassian.com/c/compass/82.md

[Latest](https://community.developer.atlassian.com/latest.md) · [Categories](https://community.developer.atlassian.com/categories.md) · [Tags](https://community.developer.atlassian.com/tags.md)

---

## [Welcome Compass Developers](https://community.developer.atlassian.com/t/welcome-compass-developers/55031)

<div class="topic-metadata">

**Author:** [@bentley](https://community.developer.atlassian.com/u/bentley)\
**Replies:** 0

</div>

Welcome to the Compass category! This is the place for all things related to Compass. Sign up for free access to Compass Join the Compass alpha user community About Compass Compass helps software teams document and na…

---

## [Deploy Time metrics not showing up for REST API deployment events](https://community.developer.atlassian.com/t/deploy-time-metrics-not-showing-up-for-rest-api-deployment-events/98547)

<div class="topic-metadata">

**Author:** [@AndrewHarmon](https://community.developer.atlassian.com/u/AndrewHarmon)\
**Replies:** 0\
**Last updated:** [January 21, 2026, 12:42pm UTC](https://community.developer.atlassian.com/t/deploy-time-metrics-not-showing-up-for-rest-api-deployment-events/98547 "2026-01-21T12:42:02Z")

</div>

We have some repos linked to GitHub and some require using the REST api to post our build events. The GitHub linked show a Deployment Time metric, but the custom one does not. I assume it’s some bug in the way I’m postin…

---

## [Compass getting scorecard score through GraphQL API](https://community.developer.atlassian.com/t/compass-getting-scorecard-score-through-graphql-api/98388)

<div class="topic-metadata">

**Author:** [@thomasS](https://community.developer.atlassian.com/u/thomasS)\
**Replies:** 0\
**Last updated:** [January 14, 2026, 9:17am UTC](https://community.developer.atlassian.com/t/compass-getting-scorecard-score-through-graphql-api/98388 "2026-01-14T09:17:35Z")

</div>

Hi Everyone, I using the GraphQL API for compass to receive information of my components. Currently Im trying to access the status of my scorecards that are applied to a component (e.g. passing, failing, needs attention…

---

## [When I submit a deployment event, it gets tagged to multiple components, not just the one I specified the componentId for](https://community.developer.atlassian.com/t/when-i-submit-a-deployment-event-it-gets-tagged-to-multiple-components-not-just-the-one-i-specified-the-componentid-for/98224)

<div class="topic-metadata">

**Author:** [@AndrewHarmon](https://community.developer.atlassian.com/u/AndrewHarmon)\
**Replies:** 2\
**Last updated:** [January 6, 2026, 8:38pm UTC](https://community.developer.atlassian.com/t/when-i-submit-a-deployment-event-it-gets-tagged-to-multiple-components-not-just-the-one-i-specified-the-componentid-for/98224 "2026-01-06T20:38:21Z")

</div>

When I use the REST API to create a deployment event, I see that event on lots of my components, not just the component that I specified in the body for the componentID field. Here is an example payload. { "cloudId…

---

## [How do I generate an API token under a Service Account for Atlassian Compass?](https://community.developer.atlassian.com/t/how-do-i-generate-an-api-token-under-a-service-account-for-atlassian-compass/94952)

<div class="topic-metadata">

**Author:** [@SeanD](https://community.developer.atlassian.com/u/SeanD)\
**Replies:** 3\
**Last updated:** [November 13, 2025, 5:34pm UTC](https://community.developer.atlassian.com/t/how-do-i-generate-an-api-token-under-a-service-account-for-atlassian-compass/94952 "2025-11-13T17:34:21Z")

</div>

As per the title. It’s not clear at all how to get an API token to call the Compass APIs with via a Service Account user. Currently we have some automation that is using an individual person’s access token, but this is …

---

## [Is there an API to find the Compass WorkspaceID?](https://community.developer.atlassian.com/t/is-there-an-api-to-find-the-compass-workspaceid/94975)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 2\
**Last updated:** [September 2, 2025, 5:24pm UTC](https://community.developer.atlassian.com/t/is-there-an-api-to-find-the-compass-workspaceid/94975 "2025-09-02T17:24:15Z")

</div>

After some digging I found that the Compass Component ARI is build using this format ari:cloud:compass:\[CLOUD\_ID\]:component/\[WORKSPACE\_ID\]/\[COMPONENT\_SHORT\_ID\] How does one resolve the WORKSPACE\_ID for a Compass install…

---

## [Compass API suitable for operations after Opsgenie migration](https://community.developer.atlassian.com/t/compass-api-suitable-for-operations-after-opsgenie-migration/94343)

<div class="topic-metadata">

**Author:** [@BenNaylor](https://community.developer.atlassian.com/u/BenNaylor)\
**Replies:** 2\
**Last updated:** [August 5, 2025, 1:58pm UTC](https://community.developer.atlassian.com/t/compass-api-suitable-for-operations-after-opsgenie-migration/94343 "2025-08-05T13:58:07Z")

</div>

Am I going crazy, or do these APIs just not exist: https://developer.atlassian.com/cloud/compass/rest/v1/api-group-alerts/#api-v1-alerts-get I’m going through the migration process from OpsGenie to compass, and it’s pre…

---

## [DASHBOAD typeid not allowed in config-as-code yml file](https://community.developer.atlassian.com/t/dashboad-typeid-not-allowed-in-config-as-code-yml-file/92225)

<div class="topic-metadata">

**Author:** [@JE1](https://community.developer.atlassian.com/u/JE1)\
**Replies:** 1\
**Last updated:** [May 21, 2025, 11:47pm UTC](https://community.developer.atlassian.com/t/dashboad-typeid-not-allowed-in-config-as-code-yml-file/92225 "2025-05-21T23:47:29Z")

</div>

I’m trying to add a dashboard component and we use yml files to add all the content, however I get the error: "typeId" must have a value of: SERVICE, LIBRARY, APPLICATION, CAPABILITY, CLOUD\_RESOURCE, DATA\_PIPELINE, MACH…

---

## [How to find/create external alias source](https://community.developer.atlassian.com/t/how-to-find-create-external-alias-source/90875)

<div class="topic-metadata">

**Author:** [@KarlLivesey](https://community.developer.atlassian.com/u/KarlLivesey)\
**Replies:** 0\
**Last updated:** [April 2, 2025, 10:47pm UTC](https://community.developer.atlassian.com/t/how-to-find-create-external-alias-source/90875 "2025-04-02T22:47:15Z")

</div>

I’m trying to use syncComponentByExternalAlias to insert a component, since I won’t usually know the local componentId. I’m attempting to sync using 50 different values for externalSource, but I keep getting this error: …

---

## [Modal always full screen in Compass](https://community.developer.atlassian.com/t/modal-always-full-screen-in-compass/90772)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 9\
**Last updated:** [April 2, 2025, 11:46am UTC](https://community.developer.atlassian.com/t/modal-always-full-screen-in-compass/90772 "2025-04-02T11:46:52Z")

</div>

Was working on my Compass app and noticed that the Modal is no longer shown as documented here Instead is forces a fullscreen view like this: This is the UI code: \<ModalTransition\> {isOpen && ( \<Modal o…

---

## [List or delete Compass Events?](https://community.developer.atlassian.com/t/list-or-delete-compass-events/82183)

<div class="topic-metadata">

**Author:** [@MateuszKrainski](https://community.developer.atlassian.com/u/MateuszKrainski)\
**Replies:** 2\
**Last updated:** [August 1, 2024, 2:35am UTC](https://community.developer.atlassian.com/t/list-or-delete-compass-events/82183 "2024-08-01T02:35:25Z")

</div>

Hi, I’m new to Compass and it looks pretty promising! We are pushing our events and metrics manually via the APIs since the tools we’re using don’t directly integrate with Compass. Everything has been working pretty well…

---

## [Navigate directly to a Compass Component Page](https://community.developer.atlassian.com/t/navigate-directly-to-a-compass-component-page/81660)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 4\
**Last updated:** [July 23, 2024, 7:47am UTC](https://community.developer.atlassian.com/t/navigate-directly-to-a-compass-component-page/81660 "2024-07-23T07:47:12Z")

</div>

My app adds a component page to Compass, how can I navigate directly to this page? The URL I used in the UI seems to include from encoded data. Is there a specification for this so I can generate the URL outside of Comp…

---

## [Where are the Compass Component events?](https://community.developer.atlassian.com/t/where-are-the-compass-component-events/81651)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 1\
**Last updated:** [July 14, 2024, 9:55pm UTC](https://community.developer.atlassian.com/t/where-are-the-compass-component-events/81651 "2024-07-14T21:55:56Z")

</div>

For Compass apps there are only component links events but the same create, update, delete events for components themselves would also be great to have. Any change these can be added as well?

---

## [API for accessing Compass component from Jira Connect app](https://community.developer.atlassian.com/t/api-for-accessing-compass-component-from-jira-connect-app/81640)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 0\
**Last updated:** [July 7, 2024, 11:09pm UTC](https://community.developer.atlassian.com/t/api-for-accessing-compass-component-from-jira-connect-app/81640 "2024-07-07T23:09:49Z")

</div>

I would like to request all components that are configured on Compass as well as search for components by there Compass componentAri. All the Jira API work around the scope of a project, or are limited by the getting of…

---

## [How to 'customize' the icon shown next to component links](https://community.developer.atlassian.com/t/how-to-customize-the-icon-shown-next-to-component-links/81776)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 3\
**Last updated:** [July 14, 2024, 9:54pm UTC](https://community.developer.atlassian.com/t/how-to-customize-the-icon-shown-next-to-component-links/81776 "2024-07-14T21:54:19Z")

</div>

How can I influence the icon shown next to component links?

---

## [Only the last build event shown in Compass](https://community.developer.atlassian.com/t/only-the-last-build-event-shown-in-compass/81425)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 13\
**Last updated:** [July 11, 2024, 9:50am UTC](https://community.developer.atlassian.com/t/only-the-last-build-event-shown-in-compass/81425 "2024-07-11T09:50:30Z")

</div>

I’m working on an app to integration builds and deployment data, and I’m using a combination of a data-provider and a trigger to load all the data. The data-provider is triggered when a specific url is added to a compon…

---

## [Use the compass:componentImporter module](https://community.developer.atlassian.com/t/use-the-compass-componentimporter-module/81404)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 3\
**Last updated:** [July 10, 2024, 7:12am UTC](https://community.developer.atlassian.com/t/use-the-compass-componentimporter-module/81404 "2024-07-10T07:12:54Z")

</div>

I found the compass:componentImporter in the Gitlab for Compass app and would like to use this module, but its unclear where I should direct my request to use this undocumented module. Anyone from Forge or Compass teams…

---

## [Check Compass user permissions](https://community.developer.atlassian.com/t/check-compass-user-permissions/81565)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 5\
**Last updated:** [July 10, 2024, 7:09am UTC](https://community.developer.atlassian.com/t/check-compass-user-permissions/81565 "2024-07-10T07:09:28Z")

</div>

Within a Compass app, how can I check if a user is permitted to perform actions, link creating, updating and deleting component links? I’m just not able to find any Compass authorization API.

---

## [Forge UI Kit Colors not showing](https://community.developer.atlassian.com/t/forge-ui-kit-colors-not-showing/81558)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 1\
**Last updated:** [July 7, 2024, 4:04pm UTC](https://community.developer.atlassian.com/t/forge-ui-kit-colors-not-showing/81558 "2024-07-07T16:04:20Z")

</div>

Hi, I’m working on a Compass Forge app with the UI Kit and want to change the primary color of an icon, but for some reason I’m just not getting the colors to work. This is my component \<Icon glyph={icon} size="small" …

---

## [Cannot delete a component link from UI using UI kit](https://community.developer.atlassian.com/t/cannot-delete-a-component-link-from-ui-using-ui-kit/81589)

<div class="topic-metadata">

**Author:** [@markrekveld](https://community.developer.atlassian.com/u/markrekveld)\
**Replies:** 1\
**Last updated:** [July 7, 2024, 4:00pm UTC](https://community.developer.atlassian.com/t/cannot-delete-a-component-link-from-ui-using-ui-kit/81589 "2024-07-07T16:00:49Z")

</div>

I’m building a component page to ease the link management. On this page I added a delete button that should delete the link from the component and trigger the needed events. For this I have a simple button \<Button app…

---

## [Event for link deletion not triggered when a Compass component gets deleted](https://community.developer.atlassian.com/t/event-for-link-deletion-not-triggered-when-a-compass-component-gets-deleted/81046)

<div class="topic-metadata">

**Author:** [@SebastianHesse](https://community.developer.atlassian.com/u/SebastianHesse)\
**Replies:** 0\
**Last updated:** [June 21, 2024, 8:34am UTC](https://community.developer.atlassian.com/t/event-for-link-deletion-not-triggered-when-a-compass-component-gets-deleted/81046 "2024-06-21T08:34:52Z")

</div>

I’m adding a data provider for components when certain links are added to a component. When a link gets added, I’m setting up some things in the background and I’d like to remove them again when either the link gets dele…

---

## [Dev App Portal: Compass Scopes](https://community.developer.atlassian.com/t/dev-app-portal-compass-scopes/80847)

<div class="topic-metadata">

**Author:** [@johnbluis](https://community.developer.atlassian.com/u/johnbluis)\
**Replies:** 0\
**Last updated:** [June 13, 2024, 6:28pm UTC](https://community.developer.atlassian.com/t/dev-app-portal-compass-scopes/80847 "2024-06-13T18:28:42Z")

</div>

Is there a plan to add Compass scopes to applications in the developer application portal? Currently my only option appears to be user access tokens which will only be useful for PoC work.

---

## [Error 500, 'The compass catalog schema has changed. Try upgrading SDK package version.'](https://community.developer.atlassian.com/t/error-500-the-compass-catalog-schema-has-changed-try-upgrading-sdk-package-version/74764)

<div class="topic-metadata">

**Author:** [@GeorgeNikolopoulos](https://community.developer.atlassian.com/u/GeorgeNikolopoulos)\
**Replies:** 2\
**Last updated:** [April 11, 2024, 9:15am UTC](https://community.developer.atlassian.com/t/error-500-the-compass-catalog-schema-has-changed-try-upgrading-sdk-package-version/74764 "2024-04-11T09:15:23Z")

</div>

Trying to use the graphql api with @atlassian/forge-graphql, doing any request so far gives me Error 500 with ‘The compass catalog schema has changed. Try upgrading SDK package version.’. I definitely have the latest ver…

---

## [Tier and Lifecycle fields values on Graph API](https://community.developer.atlassian.com/t/tier-and-lifecycle-fields-values-on-graph-api/78789)

<div class="topic-metadata">

**Author:** [@OVOFoyerServiceAccou](https://community.developer.atlassian.com/u/OVOFoyerServiceAccou)\
**Replies:** 1\
**Last updated:** [April 3, 2024, 3:25pm UTC](https://community.developer.atlassian.com/t/tier-and-lifecycle-fields-values-on-graph-api/78789 "2024-04-03T15:25:46Z")

</div>

Hi, I am using the GraphQL API to get back Compass Components. There does not seem a way to get the Tier and Lifecycle fields values. You can get back the meta deta like Name/Description/Options etc but not the value …

---

## [Compass link event payload has the wrong URL](https://community.developer.atlassian.com/t/compass-link-event-payload-has-the-wrong-url/77997)

<div class="topic-metadata">

**Author:** [@AndreaJames](https://community.developer.atlassian.com/u/AndreaJames)\
**Replies:** 0\
**Last updated:** [March 6, 2024, 1:29am UTC](https://community.developer.atlassian.com/t/compass-link-event-payload-has-the-wrong-url/77997 "2024-03-06T01:29:50Z")

</div>

Hi Community, I’m developing a Forge application to help with ingesting performance metrics from New Relic into Compass. I’m storing some data about the New Relic entities related to my component, so when the link is de…

---

## [Hey Compass team, meet the Atlassian Ecosystem 👋🏻](https://community.developer.atlassian.com/t/hey-compass-team-meet-the-atlassian-ecosystem/75502)

<div class="topic-metadata">

**Author:** [@remie](https://community.developer.atlassian.com/u/remie)\
**Replies:** 25\
**Last updated:** [February 23, 2024, 4:29pm UTC](https://community.developer.atlassian.com/t/hey-compass-team-meet-the-atlassian-ecosystem/75502 "2024-02-23T16:29:23Z")

</div>

Hey Compass team! :wave:t2: Nice to meet you here on the Atlassian Developer Community. I guess you’ve never actually released a real feature unless it has broken multiple Atlassian apps :joy: In this case, I’m talking…

---

## [Compass Push Metric using cURL - missing field, but no clue which one](https://community.developer.atlassian.com/t/compass-push-metric-using-curl-missing-field-but-no-clue-which-one/77237)

<div class="topic-metadata">

**Author:** [@NeillHolland1](https://community.developer.atlassian.com/u/NeillHolland1)\
**Replies:** 1\
**Last updated:** [February 13, 2024, 1:55pm UTC](https://community.developer.atlassian.com/t/compass-push-metric-using-curl-missing-field-but-no-clue-which-one/77237 "2024-02-13T13:55:47Z")

</div>

Hi there! I’m testing pushing metrics into Compass following the steps on this page: https://developer.atlassian.com/cloud/compass/components/push-metric-values-using-a-curl-command/ And I’m getting the following error…

---

## [Data provider events not being saved](https://community.developer.atlassian.com/t/data-provider-events-not-being-saved/76259)

<div class="topic-metadata">

**Author:** [@AndreaJames](https://community.developer.atlassian.com/u/AndreaJames)\
**Replies:** 2\
**Last updated:** [January 18, 2024, 1:31am UTC](https://community.developer.atlassian.com/t/data-provider-events-not-being-saved/76259 "2024-01-18T01:31:48Z")

</div>

I’m working on a Forge app with a data provider which will ingest incidents and alerts from New Relic into Compass. I have followed the tutorials and reviewed the example code in the sample Statuspage repo. I can’t see…

---

## [Compass Rest API Build Events](https://community.developer.atlassian.com/t/compass-rest-api-build-events/75179)

<div class="topic-metadata">

**Author:** [@MHettiarachchige](https://community.developer.atlassian.com/u/MHettiarachchige)\
**Replies:** 2\
**Last updated:** [December 4, 2023, 10:14pm UTC](https://community.developer.atlassian.com/t/compass-rest-api-build-events/75179 "2023-12-04T22:14:08Z")

</div>

I am pushing some build events to compass using postman. I followed the REST API guide and send the build events to compass. It doesn’t have the correct icon and the build success rate is wrong. The following curl comman…

---

## [How to disable compass weekly email notifications?](https://community.developer.atlassian.com/t/how-to-disable-compass-weekly-email-notifications/74817)

<div class="topic-metadata">

**Author:** [@AlexHarper](https://community.developer.atlassian.com/u/AlexHarper)\
**Replies:** 0\
**Last updated:** [November 20, 2023, 9:38am UTC](https://community.developer.atlassian.com/t/how-to-disable-compass-weekly-email-notifications/74817 "2023-11-20T09:38:43Z")

</div>

I imported some components into Compass during the trial phase but it turns out that compass does not meet our requirements. But how do I disabled the email notifications I now receive on a weekly basis that are now irr…

[Next page](https://community.developer.atlassian.com/c/compass/82.md?page=1)
