Skip to main content

PagerDuty Plugin

The PagerDuty plugin provides real-time incident visibility and management capabilities directly within Backstage entities, allowing teams to:

  • View active and recent incidents
  • Track incident status changes
  • Access PagerDuty service metrics
  • Connect directly to PagerDuty for deeper incident management

PagerDuty OAuth App Setup​

Follow these steps to register an OAuth app in the PagerDuty dashboard.

  1. Log in to your PagerDuty account.

  2. From the top menu, select Integrations.

  3. Under Developer Tools, select App Registration.

    This opens the My Apps page.

  4. On the My Apps page, select New App.

    The Add New App dialog opens.

  5. Enter a name and description for your app.

  6. In the Functionality section, select OAuth 2.0, then click Next.

  7. Select Scoped OAuth as the preferred authorization mechanism.

  8. Select the following permissions, then click Register App:

    • abilities.read (used in scaffolder only)
    • analytics.read
    • escalation_policies.read
    • incidents.read
    • oncalls.read
    • schedules.read
    • services.read
    • services.write (used in scaffolder only)
    • standards.read
    • teams.read
    • users.read
    • vendors.read (used in scaffolder only)

  9. Copy the Client ID and Client Secret values, and store them somewhere safe.

    You will use them later to configure the plugin in Venue.sh.

Annotating Entities​

To link entities with specific PagerDuty services, be sure to add the service-id when you import an entity:

annotations:
  pagerduty.com/service-id: [SERVICE-ID]

You can find the service ID by navigating to a service with a PagerDuty console and pulling the ID value out of the URL. For example: https://[YOUR-ACCOUNT].pagerduty.com/service-directory/[SERVICE-ID].

Configuring the PagerDuty Plugin in Venue.sh​

  1. In the Venue.sh app, click Plugins in the left-side navigation.

  2. Find PagerDuty, then click Enable Plugin.

  3. Enter the Client ID value.

    You should have noted and saved this value in Step 9 in the PagerDuty-configuration task above.

  4. Enter the Client Secret.

    You should have noted and saved this value in Step 9 in the PagerDuty-configuration task above.

  5. Enter your PagerDuty Subdomain value.

  6. Optional: Enter a Region value, either us (default) or eu to reflect the location of your PagerDuty instance.

  7. Click Validate & Enable.