Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Rootly
  4. API Docs
  5. Schedule
Viewing docs for Rootly v4.2.2
published on Thursday, Nov 12, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.Schedule

rootly logo Rootly
Viewing docs for Rootly v4.2.2
published on Thursday, Nov 12, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Manages a schedule.

    Example Usage

    data "rootly_user" "john" {
  email = "demo@rootly.com"
}

data "rootly_user" "jane" {
  email = "demo1@rootly.com"
}

resource "rootly_schedule" "primary" {
  name              = "Primary On-Call Schedule"
  owner_user_id     = data.rootly_user.john.id
  all_time_coverage = false
}

resource "rootly_schedule_rotation" "weekdays" {
  schedule_id     = rootly_schedule.primary.id
  name            = "weekdays"
  active_all_week = false
  active_days = [
    "M",
    "T",
    "W",
    "R",
    "F",
  ]
  active_time_type = "custom"
  position         = 1
  schedule_rotationable_attributes = {
    handoff_time = "T",
    handoff_time = "10:00"
  }
  schedule_rotationable_type = "ScheduleWeeklyRotation"
  time_zone                  = "America/Toronto"
}

# Define active days for the weekday rotation
# Monday
resource "rootly_schedule_rotation_active_day" "m1-weekday" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  day_name             = "M"
  active_time_attributes {
    start_time = "10:00"
    end_time   = "18:00"
  }
}
# Tuesday
resource "rootly_schedule_rotation_active_day" "t1-weekday" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  day_name             = "T"
  active_time_attributes {
    start_time = "10:00"
    end_time   = "18:00"
  }
}
# Wednesday
resource "rootly_schedule_rotation_active_day" "w1-weekday" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  day_name             = "W"
  active_time_attributes {
    start_time = "10:00"
    end_time   = "18:00"
  }
}
# Thursday
resource "rootly_schedule_rotation_active_day" "th1-weekday" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  day_name             = "R"
  active_time_attributes {
    start_time = "10:00"
    end_time   = "18:00"
  }
}
# Friday
resource "rootly_schedule_rotation_active_day" "f1-weekday" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  day_name             = "F"
  active_time_attributes {
    start_time = "10:00"
    end_time   = "18:00"
  }
}

resource "rootly_schedule_rotation_user" "john" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  position             = 1
  user_id              = data.rootly_user.john.id
}

resource "rootly_schedule_rotation_user" "jane" {
  schedule_rotation_id = rootly_schedule_rotation.weekdays.id
  position             = 2
  user_id              = data.rootly_user.jane.id
}

    Create Schedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Schedule(name: string, args?: ScheduleArgs, opts?: CustomResourceOptions);
    @overload
def Schedule(resource_name: str,
             args: Optional[ScheduleArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Schedule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             all_time_coverage: Optional[bool] = None,
             business_hours: Optional[ScheduleBusinessHoursArgs] = None,
             description: Optional[str] = None,
             include_shadows_in_slack_notifications: Optional[bool] = None,
             name: Optional[str] = None,
             owner_group_ids: Optional[Sequence[str]] = None,
             owner_user_id: Optional[int] = None,
             shift_report_day_of_week: Optional[str] = None,
             shift_report_enabled: Optional[bool] = None,
             shift_report_time_of_day: Optional[str] = None,
             shift_report_time_zone: Optional[str] = None,
             shift_start_notifications_enabled: Optional[bool] = None,
             shift_update_notifications_enabled: Optional[bool] = None,
             slack_channel: Optional[ScheduleSlackChannelArgs] = None,
             slack_user_group: Optional[ScheduleSlackUserGroupArgs] = None,
             sync_linear_enabled: Optional[bool] = None,
             time_zone: Optional[str] = None)
    func NewSchedule(ctx *Context, name string, args *ScheduleArgs, opts ...ResourceOption) (*Schedule, error)
    public Schedule(string name, ScheduleArgs? args = null, CustomResourceOptions? opts = null)
    public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)

    type: rootly:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "rootly_schedule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scheduleResource = new Rootly.Schedule("scheduleResource", new()
{
    AllTimeCoverage = false,
    BusinessHours = new Rootly.Inputs.ScheduleBusinessHoursArgs
    {
        EndTime = "string",
        IncludeWeekends = false,
        StartTime = "string",
    },
    Description = "string",
    IncludeShadowsInSlackNotifications = false,
    Name = "string",
    OwnerGroupIds = new[]
    {
        "string",
    },
    OwnerUserId = 0,
    ShiftReportDayOfWeek = "string",
    ShiftReportEnabled = false,
    ShiftReportTimeOfDay = "string",
    ShiftReportTimeZone = "string",
    ShiftStartNotificationsEnabled = false,
    ShiftUpdateNotificationsEnabled = false,
    SlackChannel = new Rootly.Inputs.ScheduleSlackChannelArgs
    {
        Id = "string",
        Name = "string",
    },
    SlackUserGroup = new Rootly.Inputs.ScheduleSlackUserGroupArgs
    {
        Id = "string",
        Name = "string",
    },
    SyncLinearEnabled = false,
    TimeZone = "string",
});

    example, err := rootly.NewSchedule(ctx, "scheduleResource", &rootly.ScheduleArgs{
	AllTimeCoverage: pulumi.Bool(false),
	BusinessHours: &rootly.ScheduleBusinessHoursArgs{
		EndTime:         pulumi.String("string"),
		IncludeWeekends: pulumi.Bool(false),
		StartTime:       pulumi.String("string"),
	},
	Description:                        pulumi.String("string"),
	IncludeShadowsInSlackNotifications: pulumi.Bool(false),
	Name:                               pulumi.String("string"),
	OwnerGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	OwnerUserId:                     pulumi.Int(0),
	ShiftReportDayOfWeek:            pulumi.String("string"),
	ShiftReportEnabled:              pulumi.Bool(false),
	ShiftReportTimeOfDay:            pulumi.String("string"),
	ShiftReportTimeZone:             pulumi.String("string"),
	ShiftStartNotificationsEnabled:  pulumi.Bool(false),
	ShiftUpdateNotificationsEnabled: pulumi.Bool(false),
	SlackChannel: &rootly.ScheduleSlackChannelArgs{
		Id:   pulumi.String("string"),
		Name: pulumi.String("string"),
	},
	SlackUserGroup: &rootly.ScheduleSlackUserGroupArgs{
		Id:   pulumi.String("string"),
		Name: pulumi.String("string"),
	},
	SyncLinearEnabled: pulumi.Bool(false),
	TimeZone:          pulumi.String("string"),
})

    resource "rootly_schedule" "scheduleResource" {
  lifecycle {
    create_before_destroy = true
  }
  all_time_coverage = false
  business_hours = {
    end_time         = "string"
    include_weekends = false
    start_time       = "string"
  }
  description                            = "string"
  include_shadows_in_slack_notifications = false
  name                                   = "string"
  owner_group_ids                        = ["string"]
  owner_user_id                          = 0
  shift_report_day_of_week               = "string"
  shift_report_enabled                   = false
  shift_report_time_of_day               = "string"
  shift_report_time_zone                 = "string"
  shift_start_notifications_enabled      = false
  shift_update_notifications_enabled     = false
  slack_channel = {
    id   = "string"
    name = "string"
  }
  slack_user_group = {
    id   = "string"
    name = "string"
  }
  sync_linear_enabled = false
  time_zone           = "string"
}

    var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()
    .allTimeCoverage(false)
    .businessHours(ScheduleBusinessHoursArgs.builder()
        .endTime("string")
        .includeWeekends(false)
        .startTime("string")
        .build())
    .description("string")
    .includeShadowsInSlackNotifications(false)
    .name("string")
    .ownerGroupIds("string")
    .ownerUserId(0)
    .shiftReportDayOfWeek("string")
    .shiftReportEnabled(false)
    .shiftReportTimeOfDay("string")
    .shiftReportTimeZone("string")
    .shiftStartNotificationsEnabled(false)
    .shiftUpdateNotificationsEnabled(false)
    .slackChannel(ScheduleSlackChannelArgs.builder()
        .id("string")
        .name("string")
        .build())
    .slackUserGroup(ScheduleSlackUserGroupArgs.builder()
        .id("string")
        .name("string")
        .build())
    .syncLinearEnabled(false)
    .timeZone("string")
    .build());

    schedule_resource = rootly.Schedule("scheduleResource",
    all_time_coverage=False,
    business_hours={
        "end_time": "string",
        "include_weekends": False,
        "start_time": "string",
    },
    description="string",
    include_shadows_in_slack_notifications=False,
    name="string",
    owner_group_ids=["string"],
    owner_user_id=0,
    shift_report_day_of_week="string",
    shift_report_enabled=False,
    shift_report_time_of_day="string",
    shift_report_time_zone="string",
    shift_start_notifications_enabled=False,
    shift_update_notifications_enabled=False,
    slack_channel={
        "id": "string",
        "name": "string",
    },
    slack_user_group={
        "id": "string",
        "name": "string",
    },
    sync_linear_enabled=False,
    time_zone="string")

    const scheduleResource = new rootly.Schedule("scheduleResource", {
    allTimeCoverage: false,
    businessHours: {
        endTime: "string",
        includeWeekends: false,
        startTime: "string",
    },
    description: "string",
    includeShadowsInSlackNotifications: false,
    name: "string",
    ownerGroupIds: ["string"],
    ownerUserId: 0,
    shiftReportDayOfWeek: "string",
    shiftReportEnabled: false,
    shiftReportTimeOfDay: "string",
    shiftReportTimeZone: "string",
    shiftStartNotificationsEnabled: false,
    shiftUpdateNotificationsEnabled: false,
    slackChannel: {
        id: "string",
        name: "string",
    },
    slackUserGroup: {
        id: "string",
        name: "string",
    },
    syncLinearEnabled: false,
    timeZone: "string",
});

    type: rootly:Schedule
properties:
    allTimeCoverage: false
    businessHours:
        endTime: string
        includeWeekends: false
        startTime: string
    description: string
    includeShadowsInSlackNotifications: false
    name: string
    ownerGroupIds:
        - string
    ownerUserId: 0
    shiftReportDayOfWeek: string
    shiftReportEnabled: false
    shiftReportTimeOfDay: string
    shiftReportTimeZone: string
    shiftStartNotificationsEnabled: false
    shiftUpdateNotificationsEnabled: false
    slackChannel:
        id: string
        name: string
    slackUserGroup:
        id: string
        name: string
    syncLinearEnabled: false
    timeZone: string

    Schedule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Schedule resource accepts the following input properties:

    AllTimeCoverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    BusinessHours ScheduleBusinessHours
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    Description string
    The description of the schedule.
    IncludeShadowsInSlackNotifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    Name string
    The name of the schedule.
    OwnerGroupIds List<string>
    The owning teams for this schedules.
    OwnerUserId int
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    ShiftReportDayOfWeek string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    ShiftReportEnabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    ShiftReportTimeOfDay string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    ShiftReportTimeZone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    ShiftStartNotificationsEnabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    ShiftUpdateNotificationsEnabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    SlackChannel ScheduleSlackChannel
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SlackUserGroup ScheduleSlackUserGroup
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SyncLinearEnabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    TimeZone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    AllTimeCoverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    BusinessHours ScheduleBusinessHoursArgs
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    Description string
    The description of the schedule.
    IncludeShadowsInSlackNotifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    Name string
    The name of the schedule.
    OwnerGroupIds []string
    The owning teams for this schedules.
    OwnerUserId int
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    ShiftReportDayOfWeek string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    ShiftReportEnabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    ShiftReportTimeOfDay string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    ShiftReportTimeZone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    ShiftStartNotificationsEnabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    ShiftUpdateNotificationsEnabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    SlackChannel ScheduleSlackChannelArgs
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SlackUserGroup ScheduleSlackUserGroupArgs
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SyncLinearEnabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    TimeZone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    all_time_coverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    business_hours object
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description string
    The description of the schedule.
    include_shadows_in_slack_notifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name string
    The name of the schedule.
    owner_group_ids list(string)
    The owning teams for this schedules.
    owner_user_id number
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shift_report_day_of_week string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shift_report_enabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shift_report_time_of_day string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shift_report_time_zone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shift_start_notifications_enabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shift_update_notifications_enabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slack_channel object
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slack_user_group object
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    sync_linear_enabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    time_zone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    allTimeCoverage Boolean
    24/7 coverage of the schedule. Value must be one of true or false.
    businessHours ScheduleBusinessHours
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description String
    The description of the schedule.
    includeShadowsInSlackNotifications Boolean
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name String
    The name of the schedule.
    ownerGroupIds List<String>
    The owning teams for this schedules.
    ownerUserId Integer
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shiftReportDayOfWeek String
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shiftReportEnabled Boolean
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shiftReportTimeOfDay String
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shiftReportTimeZone String
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shiftStartNotificationsEnabled Boolean
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shiftUpdateNotificationsEnabled Boolean
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slackChannel ScheduleSlackChannel
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slackUserGroup ScheduleSlackUserGroup
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    syncLinearEnabled Boolean
    Whether the schedule is synced with Linear. Value must be one of true or false.
    timeZone String
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    allTimeCoverage boolean
    24/7 coverage of the schedule. Value must be one of true or false.
    businessHours ScheduleBusinessHours
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description string
    The description of the schedule.
    includeShadowsInSlackNotifications boolean
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name string
    The name of the schedule.
    ownerGroupIds string[]
    The owning teams for this schedules.
    ownerUserId number
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shiftReportDayOfWeek string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shiftReportEnabled boolean
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shiftReportTimeOfDay string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shiftReportTimeZone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shiftStartNotificationsEnabled boolean
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shiftUpdateNotificationsEnabled boolean
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slackChannel ScheduleSlackChannel
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slackUserGroup ScheduleSlackUserGroup
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    syncLinearEnabled boolean
    Whether the schedule is synced with Linear. Value must be one of true or false.
    timeZone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    all_time_coverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    business_hours ScheduleBusinessHoursArgs
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description str
    The description of the schedule.
    include_shadows_in_slack_notifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name str
    The name of the schedule.
    owner_group_ids Sequence[str]
    The owning teams for this schedules.
    owner_user_id int
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shift_report_day_of_week str
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shift_report_enabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shift_report_time_of_day str
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shift_report_time_zone str
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shift_start_notifications_enabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shift_update_notifications_enabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slack_channel ScheduleSlackChannelArgs
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slack_user_group ScheduleSlackUserGroupArgs
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    sync_linear_enabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    time_zone str
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    allTimeCoverage Boolean
    24/7 coverage of the schedule. Value must be one of true or false.
    businessHours Property Map
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description String
    The description of the schedule.
    includeShadowsInSlackNotifications Boolean
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name String
    The name of the schedule.
    ownerGroupIds List<String>
    The owning teams for this schedules.
    ownerUserId Number
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shiftReportDayOfWeek String
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shiftReportEnabled Boolean
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shiftReportTimeOfDay String
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shiftReportTimeZone String
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shiftStartNotificationsEnabled Boolean
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shiftUpdateNotificationsEnabled Boolean
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slackChannel Property Map
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slackUserGroup Property Map
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    syncLinearEnabled Boolean
    Whether the schedule is synced with Linear. Value must be one of true or false.
    timeZone String
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Schedule Resource

    Get an existing Schedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScheduleState, opts?: CustomResourceOptions): Schedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        all_time_coverage: Optional[bool] = None,
        business_hours: Optional[ScheduleBusinessHoursArgs] = None,
        description: Optional[str] = None,
        include_shadows_in_slack_notifications: Optional[bool] = None,
        name: Optional[str] = None,
        owner_group_ids: Optional[Sequence[str]] = None,
        owner_user_id: Optional[int] = None,
        shift_report_day_of_week: Optional[str] = None,
        shift_report_enabled: Optional[bool] = None,
        shift_report_time_of_day: Optional[str] = None,
        shift_report_time_zone: Optional[str] = None,
        shift_start_notifications_enabled: Optional[bool] = None,
        shift_update_notifications_enabled: Optional[bool] = None,
        slack_channel: Optional[ScheduleSlackChannelArgs] = None,
        slack_user_group: Optional[ScheduleSlackUserGroupArgs] = None,
        sync_linear_enabled: Optional[bool] = None,
        time_zone: Optional[str] = None) -> Schedule
    func GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)
    public static Schedule Get(string name, Input<string> id, ScheduleState? state, CustomResourceOptions? opts = null)
    public static Schedule get(String name, Output<String> id, ScheduleState state, CustomResourceOptions options)
    resources:  _:    type: rootly:Schedule    get:      id: ${id}
    import {
  to = rootly_schedule.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllTimeCoverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    BusinessHours ScheduleBusinessHours
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    Description string
    The description of the schedule.
    IncludeShadowsInSlackNotifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    Name string
    The name of the schedule.
    OwnerGroupIds List<string>
    The owning teams for this schedules.
    OwnerUserId int
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    ShiftReportDayOfWeek string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    ShiftReportEnabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    ShiftReportTimeOfDay string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    ShiftReportTimeZone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    ShiftStartNotificationsEnabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    ShiftUpdateNotificationsEnabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    SlackChannel ScheduleSlackChannel
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SlackUserGroup ScheduleSlackUserGroup
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SyncLinearEnabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    TimeZone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    AllTimeCoverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    BusinessHours ScheduleBusinessHoursArgs
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    Description string
    The description of the schedule.
    IncludeShadowsInSlackNotifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    Name string
    The name of the schedule.
    OwnerGroupIds []string
    The owning teams for this schedules.
    OwnerUserId int
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    ShiftReportDayOfWeek string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    ShiftReportEnabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    ShiftReportTimeOfDay string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    ShiftReportTimeZone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    ShiftStartNotificationsEnabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    ShiftUpdateNotificationsEnabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    SlackChannel ScheduleSlackChannelArgs
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SlackUserGroup ScheduleSlackUserGroupArgs
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    SyncLinearEnabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    TimeZone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    all_time_coverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    business_hours object
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description string
    The description of the schedule.
    include_shadows_in_slack_notifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name string
    The name of the schedule.
    owner_group_ids list(string)
    The owning teams for this schedules.
    owner_user_id number
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shift_report_day_of_week string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shift_report_enabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shift_report_time_of_day string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shift_report_time_zone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shift_start_notifications_enabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shift_update_notifications_enabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slack_channel object
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slack_user_group object
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    sync_linear_enabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    time_zone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    allTimeCoverage Boolean
    24/7 coverage of the schedule. Value must be one of true or false.
    businessHours ScheduleBusinessHours
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description String
    The description of the schedule.
    includeShadowsInSlackNotifications Boolean
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name String
    The name of the schedule.
    ownerGroupIds List<String>
    The owning teams for this schedules.
    ownerUserId Integer
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shiftReportDayOfWeek String
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shiftReportEnabled Boolean
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shiftReportTimeOfDay String
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shiftReportTimeZone String
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shiftStartNotificationsEnabled Boolean
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shiftUpdateNotificationsEnabled Boolean
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slackChannel ScheduleSlackChannel
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slackUserGroup ScheduleSlackUserGroup
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    syncLinearEnabled Boolean
    Whether the schedule is synced with Linear. Value must be one of true or false.
    timeZone String
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    allTimeCoverage boolean
    24/7 coverage of the schedule. Value must be one of true or false.
    businessHours ScheduleBusinessHours
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description string
    The description of the schedule.
    includeShadowsInSlackNotifications boolean
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name string
    The name of the schedule.
    ownerGroupIds string[]
    The owning teams for this schedules.
    ownerUserId number
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shiftReportDayOfWeek string
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shiftReportEnabled boolean
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shiftReportTimeOfDay string
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shiftReportTimeZone string
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shiftStartNotificationsEnabled boolean
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shiftUpdateNotificationsEnabled boolean
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slackChannel ScheduleSlackChannel
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slackUserGroup ScheduleSlackUserGroup
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    syncLinearEnabled boolean
    Whether the schedule is synced with Linear. Value must be one of true or false.
    timeZone string
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    all_time_coverage bool
    24/7 coverage of the schedule. Value must be one of true or false.
    business_hours ScheduleBusinessHoursArgs
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description str
    The description of the schedule.
    include_shadows_in_slack_notifications bool
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name str
    The name of the schedule.
    owner_group_ids Sequence[str]
    The owning teams for this schedules.
    owner_user_id int
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shift_report_day_of_week str
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shift_report_enabled bool
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shift_report_time_of_day str
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shift_report_time_zone str
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shift_start_notifications_enabled bool
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shift_update_notifications_enabled bool
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slack_channel ScheduleSlackChannelArgs
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slack_user_group ScheduleSlackUserGroupArgs
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    sync_linear_enabled bool
    Whether the schedule is synced with Linear. Value must be one of true or false.
    time_zone str
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.
    allTimeCoverage Boolean
    24/7 coverage of the schedule. Value must be one of true or false.
    businessHours Property Map
    Controls shadow paging on the schedule. To enable, specify all nested attributes. To remove, set the attribute to an empty object {}. startTime and endTime are HH:MM 24-hour format strings.
    description String
    The description of the schedule.
    includeShadowsInSlackNotifications Boolean
    Whether shadow users are included in Slack notifications and user group syncing. Value must be one of true or false.
    name String
    The name of the schedule.
    ownerGroupIds List<String>
    The owning teams for this schedules.
    ownerUserId Number
    ID of user assigned as owner of the schedule. Defaults to the API token's user if not specified.
    shiftReportDayOfWeek String
    Day of week the weekly shift summary is sent. Value must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    shiftReportEnabled Boolean
    Whether the weekly shift summary report is sent. Requires slackChannel to be set. Value must be one of true or false.
    shiftReportTimeOfDay String
    Time of day the weekly shift summary is sent, in HH:MM 24-hour format.
    shiftReportTimeZone String
    IANA time zone used for the weekly shift summary (e.g. Australia/Sydney).
    shiftStartNotificationsEnabled Boolean
    Whether to send a Slack message every time a new shift begins. Requires slackChannel to be set. Value must be one of true or false.
    shiftUpdateNotificationsEnabled Boolean
    Whether to send a Slack message whenever a shift is updated (overrides, removed users, rotation changes, etc.). Requires slackChannel to be set. Value must be one of true or false.
    slackChannel Property Map
    Synced slack channel of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    slackUserGroup Property Map
    Synced slack group of the schedule. To set, specify all nested attributes. To remove, set the attribute to an empty object {}.
    syncLinearEnabled Boolean
    Whether the schedule is synced with Linear. Value must be one of true or false.
    timeZone String
    A valid IANA time zone name. Only applicable when configonetimezoneperschedule_enabled is true for the organization.

    Supporting Types

    ScheduleBusinessHours, ScheduleBusinessHoursArgs

    EndTime string
    End time in HH:MM 24-hour format.
    IncludeWeekends bool
    Whether to include weekends.
    StartTime string
    Start time in HH:MM 24-hour format.
    EndTime string
    End time in HH:MM 24-hour format.
    IncludeWeekends bool
    Whether to include weekends.
    StartTime string
    Start time in HH:MM 24-hour format.
    end_time string
    End time in HH:MM 24-hour format.
    include_weekends bool
    Whether to include weekends.
    start_time string
    Start time in HH:MM 24-hour format.
    endTime String
    End time in HH:MM 24-hour format.
    includeWeekends Boolean
    Whether to include weekends.
    startTime String
    Start time in HH:MM 24-hour format.
    endTime string
    End time in HH:MM 24-hour format.
    includeWeekends boolean
    Whether to include weekends.
    startTime string
    Start time in HH:MM 24-hour format.
    end_time str
    End time in HH:MM 24-hour format.
    include_weekends bool
    Whether to include weekends.
    start_time str
    Start time in HH:MM 24-hour format.
    endTime String
    End time in HH:MM 24-hour format.
    includeWeekends Boolean
    Whether to include weekends.
    startTime String
    Start time in HH:MM 24-hour format.

    ScheduleSlackChannel, ScheduleSlackChannelArgs

    Id string
    Slack channel ID.
    Name string
    Slack channel name.
    Id string
    Slack channel ID.
    Name string
    Slack channel name.
    id string
    Slack channel ID.
    name string
    Slack channel name.
    id String
    Slack channel ID.
    name String
    Slack channel name.
    id string
    Slack channel ID.
    name string
    Slack channel name.
    id str
    Slack channel ID.
    name str
    Slack channel name.
    id String
    Slack channel ID.
    name String
    Slack channel name.

    ScheduleSlackUserGroup, ScheduleSlackUserGroupArgs

    Id string
    Slack user group ID.
    Name string
    Slack user group name.
    Id string
    Slack user group ID.
    Name string
    Slack user group name.
    id string
    Slack user group ID.
    name string
    Slack user group name.
    id String
    Slack user group ID.
    name String
    Slack user group name.
    id string
    Slack user group ID.
    name string
    Slack user group name.
    id str
    Slack user group ID.
    name str
    Slack user group name.
    id String
    Slack user group ID.
    name String
    Slack user group name.

    Import

    rootly.Schedule can be imported using the import command.

    $ pulumi import rootly:index/schedule:Schedule primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo Rootly
    Viewing docs for Rootly v4.2.2
    published on Thursday, Nov 12, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial