Editing Existing Schedules

As new users join and other users leave your on-call rotations, you will need to edit your on-call schedules so that the right people are on-call and notified at the right times.

Any changes made to a schedule (including adding and removing users) won't affect the historical record of that schedule — changes will only apply to future dates and times. Make sure to check the effective date for changes to make sure that the schedule rotates on the right date and time when you add or remove a user.

Note

Any changes made to a schedule (including adding and removing users) won't affect the historical record of that schedule — changes will only apply to future dates and times. Make sure to check the effective date for changes to make sure that the schedule rotates on the right date and time when you add or remove a user. If you want to revert a schedule to a previous state, please visit this section.

If you are creating a schedule for the first time, please visit our article on Schedule Basics.

Adding Users to Existing Schedules

Required User Permissions

All users, with the exception of Limited and Full Stakeholders, can be added to schedules.

If you're not sure what role you have, or if you need your permissions adjusted, visit our sections on Checking Your User Role or Changing User Roles.

To add additional users to an existing on-call schedule:

  1. Navigate to Configuration and select Schedules.
  2. Click the gear icon for an existing on-call schedule and select Edit.
  1. Click Select a User to choose a user's name from the dropdown or search for it to add a user to the on-call schedule layer. When you click the user’s name, it will add them to the schedule.
  1. Repeat until required users are added. Users will move through the rotation in the top-to-bottom order they are listed in. If they are in the wrong rotation order, you can also drag and drop users into a different order.
  1. Click Save Changes in the upper right hand corner of the screen.

Removing Users From Existing Schedules

To permanently remove a user from an on-call schedule:

  1. Navigate to Configuration and select Schedules.
  2. Click the gear icon for the existing on-call schedule and select Edit.
  3. Click the X next to the user's name that you want to remove.
  1. Click Save Changes in the upper right hand corner.

Create and Delete Overrides

Overrides are used to make manual one-time adjustments to on-call schedules. Overrides are most commonly used when a user is sick, goes on vacation, or would like to swap on-call periods with someone else.

Scheduling an override creates an override layer over the existing schedule. Scheduled overrides are displayed beneath your schedule layers, as the lowest layer before the Final Schedule (the lowest layer always takes precedence).

You can create overrides within the PagerDuty web UI, or you can create them using the REST API.

Required User Permissions

All users, with the exception of Restricted Access, Observers, Limited Stakeholders and Full Stakeholders, can create Overrides.

If you're not sure what role you have, or if you need your permissions adjusted, visit our sections on Checking Your User Role or Changing User Roles.

Create Overrides in the Web UI

There are two places to schedule overrides on existing schedules in PagerDuty:

Override a specific schedule shift

Scheduling an override by clicking directly on the shift you'd like to override will pre-populate the override window with the effective dates and times, without you having to manually punch them in.

  1. Navigate to Configuration and select Schedules.
  2. From the main Schedules page or from the individual schedule's edit page, click directly on the shift that you would like to override. If need be, you can tab forward by days, weeks, and months to locate the shift you would like to override.
  3. The Schedule an Override window will be pre-populated with the times of the shift that you just clicked. Make the necessary changes to the Person you're adding for the override and click Create Override and the override will immediately appear on the schedule..

Override any span of time on a schedule

  1. Navigate to Configuration and select Schedules.
  2. Click the gear icon for the desired on-call schedule and select Schedule an Override.
  1. Or you can click into a schedule and select Schedule an Override
  1. The override window will be a pop-up. Select the Person and start/end times of the override. Click Create Override.

Create Overrides Using the REST API

An example Python script to schedule overrides for a user going on vacation can be found here: vacation_overrides.py.

To learn more about how to interact with the PagerDuty API, we recommend checking out the collection of scripts our community has created on our Knowledge Base. Our developer docs also provide more information on creating and deleting overrides using the REST API.

Delete an Override

You can delete upcoming overrides on your schedule in the event that the override is no longer needed. If an override is deleted during the middle of the scheduled shift, the regular schedule will resume from the time of the override's deletion. You cannot delete past overrides; only present or future ones.

To delete an override:

  1. While on the Schedules page, click on the name of the schedule or select View after clicking on the gear for the schedule you would like to change.
  2. In the Upcoming Overrides list, click the X to delete the override.

Pause or Deactivate an On-call Schedule

Sometimes you might want to stop a schedule from being used without deleting it.

For example:

  • If the schedule is a draft which you are not ready to implement. (Note, however, that you can set an effective date for future changes without deactivating your current schedule)

  • If the schedule needs to be used regularly but only for special events, such as on-call shadowing.

To prevent an on-call schedule from being used, you will want to either remove the schedule from any escalation policies it is assigned to, or change the escalation policy used by your services to one that does not use the schedule.

Option 1: Remove a Schedule from an Escalation Policy

The right sidebar will display any escalation policies where the schedule is in use.

Click on the escalation policy you want to remove the schedule from, then click Edit Escalation Policy on the top right corner of the page.

Find your schedule in the Notify the following users or schedules field, then click the X button on the schedule object to remove it from the rule.

Note

If the schedule is the only target (person or schedule) in the escalation rule, you will need to click the X button on the rule to delete the entire rule, as each rule must contain at least one target.

Click Save when you are done, and repeat this process for any additional escalation policies this schedule is used by.

Option 2: Change the Escalation Policy for a Service

Please visit our article on Escalation Policies and Services for instructions on how to change the escalation policy used by a service. This will ensure that incidents triggered for the service do not alert the schedule you want to deactivate.

Restore a Schedule to a Previous Version

If you or another user alters a schedule in an undesired way, you can quickly revert a schedule back to a previously saved version. This feature also allows you to see when each saved change was made.

To revert a schedule:

  1. Click on Configuration → Schedules.
  2. Click on the name of the schedule that you wish to revert to open its details.
  3. On the right hand side of the page, click on Revert this Schedule to view the recent changes made to that schedule.
  1. Once you select one of the options from the dropdown, you will be brought to the Edit Schedule page for that version of the schedule. From here you may make additional edits, or click on Revert Schedule in the upper right corner of the page.

Limitations

Currently only changes made to the schedule layers are saved and can be reverted. Overrides will not be affected if you revert a schedule. For now, the user's name making each change is omitted. However, this is something being considered for a later release.

Editing Existing Schedules


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.