Interface PagerdutySchedule

Represents a complete PagerDuty schedule with its configuration and entries.

This is the top-level interface for a PagerDuty schedule object returned by the API. It contains both the schedule metadata (name, URL, timezone) and the actual rendered schedule entries showing who was on-call and when.

Remarks

This interface maps directly to the PagerDuty API's schedule response format. The timezone specified here is crucial for accurate OOH (Out of Hours) calculations, as it determines when "end of work day" occurs for different teams.

See

API - Get Schedule

Example

const schedule: PagerdutySchedule = {
  name: 'Engineering Primary On-Call',
  html_url: 'https://yourcompany.pagerduty.com/schedules/PXXXXXX',
  time_zone: 'Europe/London',
  final_schedule: {
    name: 'Layer 1',
    rendered_schedule_entries: [...]
  }
};

interface PagerdutySchedule {
    final_schedule: FinalSchedule;
    html_url: string;
    name: string;
    time_zone: string;
}

Index

Properties

final_schedule html_url name time_zone

Properties

final_schedule

final_schedule: FinalSchedule

The rendered final schedule containing all on-call entries. This is the processed schedule after all rotations and overrides have been applied for the requested time period.

html_url

html_url: string

Direct URL to view the schedule in PagerDuty's web interface. Useful for creating links in reports or CSV output.

Example

'https://yourcompany.pagerduty.com/schedules/PXXXXXX'

name

name: string

The human-readable name of the schedule. As configured in PagerDuty's schedule settings.

Example

'Engineering Primary On-Call'

time_zone

time_zone: string

IANA timezone identifier for the schedule. Defines the schedule's working hours and is crucial for OOH calculations. Can be overridden via command-line options if needed.

Example

'Europe/London', 'America/New_York', 'Asia/Tokyo'

Interface PagerdutySchedule

Remarks

See

Example

Index

Properties

Properties

final_schedule

html_url

Example

name

Example

time_zone

Example

Settings

On This Page