PagerDuty

PagerDuty + On-Call Optimizer Integration Benefits
  • Synchronize On-Call Optimizer’s flexible, calendar aware on-call assignments to your PagerDuty schedules.
  • Import PagerDuty schedule configuration and history into On-Call Optimizer.
  • Enjoy automated shift swap handling synchronized from On-Call Optimizer to PagerDuty.

How it Works

  • On-Call Optimizer will import the list of members and shift history from a PagerDuty schedule to an On-Call Optimizer schedule.
  • On-Call Optimizer will maintain override entries in one or more PagerDuty schedules to synchronize the on-call shifts assigned to members with the flexible, calendar aware assignments and swaps generated and managed by On-Call Optimizer.

Requirements

  • Connecting PagerDuty to On-Call Optimizer requires a PagerDuty API Key with read-write permissions to the PagerDuty schedule(s) you wish to connect.

Support

If you need help with the integration of PagerDuty and On-Call Optimizer please raise a support case from the help page within On-Call Optimizer, or contact us at support@oncall-optimizer.com.

Integration Walkthrough

In PagerDuty

  1. From the Integrations menu, select API Access Keys from the Developer Tools column.
  2. Click Create New API Key.
  3. Enter a description for the key (e.g. “On-Call Optimizer”) and click the Create Key button.
    • The Read-only API Key checkbox must remain unchecked.

Keep the generated key in a safe place for later use. You can now proceed to the In On-Call Optimizer section below.

In On-Call Optimizer

  1. Click On-Call Products in the side menu.
  2. Click Create New Connection at the bottom of the page.
  3. Click the PagerDuty logo.
  4. Enter the API Key obtained in the previous section into the API Key field and click Continue

On-Call Optimizer will begin the connection process and present the list of available PagerDuty schedules when complete. To continue onwards from this point, follow the Link an existing schedule getting started guide.

How to Uninstall

To remove a PagerDuty connection it must not be in use by any schedule in On-Call Optimizer.

  1. Identify all PagerDuty linked schedules using the green PagerDuty badge that appears to the right of their name.
    1. From the Configuration tab of the schedule, click the permanently delete link at the bottom of the page.
    2. Enter the name of the schedule in the Confirm permanent deletion text field and click the Permanently Delete Schedule button.
  2. Delete any destinations referencing the PagerDuty connection you want to remove from any schedule where they are configured.
    1. For each schedule, click the Destinations tab and review the list of configured destinations.
    2. For each destination using the connection being removed, click the Remove button on the right-hand side.

Once the connection is no longer in use by any On-Call Optimizer schedule:

  1. Select On-Call Products from the side menu.
  2. Click on the unused PagerDuty connection in the list of connections.
  3. Click the Destroy Connection button.

Additional Details

Permissions and Data Access Reference

On-Call Optimizer requires read-write PagerDuty API key to link to a PagerDuty schedule and export shifts to it as a destination.

Data accessed

On-Call Optimizer exclusively uses the Schedule and User endpoints of the PagerDuty API, and does not require access to any other API object types.

On-Call Optimizer reads the name, members and shift configuration of any available PagerDuty schedules for the purposes of presenting a list of available schedules to the user in the On-Call Optimizer application.

For any PagerDuty schedule linked to an On-Call Optimizer schedule, On-Call Optimizer will, in addition to the basic data described above, also read a list of assigned shifts and overrides on an ongoing basis for the purposes of maintaining and validating synchronization between On-Call Optimizer and PagerDuty.

For any PagerDuty schedule configured as a destination, On-Call Optimizer will create and delete override entries on the PagerDuty schedule for the purposes of bringing the PagerDuty schedule into alignment with the shift assignments in On-Call Optimizer.

While executing the above primary functions, On-Call Optimizer will also read the list of users available in the PagerDuty account for the purposes of mapping between the PagerDuty user ID and the user’s email address and full name which are required by On-Call Optimizer. On-Call Optimizer does not access or store any other attributes of PagerDuty users (e.g. phone numbers or contact methods).


Last updated October 30, 2024