Last updated Jun 24, 2024

Integrate Compass with Statuspage

Statuspage is an incident management tool that enables users to communicate the status of their components. If your team uses Statuspage for incident management, you can connect your Statuspage to manage Statuspage incidents and maintenances in Compass.

Compass supports only active, public pages. Private pages are not supported at this time.

When you integrate an app with Compass, other Compass users can view events and metrics data sent from the app to Compass, even if they don't have access to that data in the underlying app. For example, when you integrate Bitbucket with Compass, someone who doesn't have access to a repository can see the events and metrics related to that repository in Compass. The same applies to data sent from this app to Compass.

Before you begin

Before setting up the integration with Statuspage, make sure that you:

Set up the integration

To set up the integration:

  1. In Compass, select Apps from the top navigation bar.
  2. On the Statuspage tile, select Install.
  3. On the Statuspage tile, select Configure.
  4. If required, complete the requested steps to allow the app to access Compass.
  5. Enter your Statuspage API Key. Learn more about Statuspage API keys
  6. Select Connect.

Now you’ve finished setting up the Statuspage integration.

Connect a component from Statuspage

Once you've finished setting up the integration, you can connect a Compass component to a Statuspage component.

To connect a Statuspage component:

  1. In the top navigation bar in Compass, select Components.
  2. Select a component that you'd like to connect a Statuspage component with.
  3. From the left menu bar select Statuspage.
  4. Select a component from the dropdown.
  5. Select Connect.
  6. Now your Statuspage component information is displayed, along with a list of active incidents and/or maintenances.

Update your Statuspage API key

If you’ve cycled your Statuspage API key, you can update it in the Statuspage integration.

To update your Statuspage API key:

  1. In Compass, select Apps from the top navigation bar.
  2. On the Statuspage tile, select Configure.
  3. Select Disconnect account.
  4. Provide an updated API key.
  5. Select Connect Statuspage account to continue using the integration.

Uninstall the Statuspage integration

You can uninstall the Statuspage integration if you don’t have a need to manage Statuspage from Compass.

  1. In Compass, select Apps from the top navigation bar.
  2. On the Statuspage tile, select Configure.
  3. Select Uninstall.

The integration is now uninstalled.

Rate this page: