Last updated Sep 12, 2022

Rate this page:

Show on-call information from incident management tools on a component

Compass supports any kind of links in the on-call section of a component’s details page. However, if you install an incident management tool like Opsgenie or PagerDuty and add the relevant link to a component, more detailed on-call information is shown.

Add an on-call schedule from your incident management tool to show which responder is on-call, when they’re on-call until, and what escalation level the responder is.

Before you begin

  • Ensure that you’re an admin on your Compass instance (you’ll need to install the app for the incident management tool you want to display on-call information from).

  • Ensure that you’re an admin or account owner for the PagerDuty account you want to connect with Compass.

  • If installing Opsgenie, ensure you're on an Essentials plan or higher.

Install the incident management app

  1. In Compass, select Apps from the top navigation bar.
  2. On the tile of the incident management tool you want to use, select Install. The app installs.
  3. On the same tile, select Configure.
  4. If you haven't already, authorize the app to access Compass on your behalf. Select Allow access and follow the on-screen instructions.
    • This step appears only once on your Compass instance for each app you install. So, if you've already authorized the app before, proceed to the next step.
  5. Generate an API key from the tool you're installing.
  6. In Compass, paste the API key from the incident management tool into the API key field.
  7. Select Connect account.
  8. Take note on what kind of link you’ll need to use on the component details page. This is the link you’ll add to your component’s details page in the next steps.
Incident management toolType of link to be pasted
OpsgenieOn-call schedule URL
PagerDutyService URL
Other toolsAny link, will display with chosen text only

Add on-call information to a component

Install the incident management app

Ensure the incident management tool is installed before taking these steps.

  1. In Compass, navigate to a component you want to connect to your incident management on-call information. On the component’s overview page, you’ll see the on-call section on the right side of the component’s details.
  2. Select + Add on-call link
  3. Paste the relevant link (note which kind of link in the table above) into the text field.
  4. Optionally, enter link text to be displayed as the card’s title (Instead of 'Opsgenie' or ‘PagerDuty’ as the card title).
  5. Select Add.

Your on-call information is displayed from the incident management tool, or a link to your on-call information is displayed where users can go to see more information. If for some reason you encounter an error after adding a schedule, make sure you entered the right type of link according to the table above.

Remove on-call information from a component

  1. In Compass, navigate to a component you want to remove your incident management on-call information from. On the component’s details page, you’ll see the on-call section on the right side of the component’s details.
  2. Select the 'X' icon next to the on-call link information you want to remove.
  3. Select Remove in the dialogue that opens to confirm.

The on-call information no longer appears in the on-call card.

Rate this page: