Preview an on-call rotation

post

https://api.firehydrant.io/v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/preview

Preview a new on-call rotation orchanges to an existing on-call rotation

Path Params

team_id

string

required

schedule_id

string

required

Body Params

rotation_id

string | null

The ID of a rotation being updated. Leave this blank if you're previewing the creation of a new rotation.

name

string | null

The name of the on-call rotation

description

string | null

The description of the on-call rotation

time_zone

string | null

The timezone of the on-call rotation as a string

slack_user_group_id

string | null

The Slack Usergroup ID for the on-call rotation

enable_slack_channel_notifications

boolean | null

Notify the team's Slack channel when handoffs occur

prevent_shift_deletion

boolean | null

Prevent shifts from being deleted by users and leading to gaps in coverage.

coverage_gap_notification_interval

string | null

An ISO8601 duration string specifying that the team should be notified about gaps in coverage for the upcoming interval. Notifications are sent at 9am daily in the rotation's time zone via email and, if enabled, the team's Slack channel.

color

string | null

A hex color code that will be used to represent the rotation in FireHydrant's UI.

members

array of objects | null

An ordered list of objects that specify members of the schedule's rotation.

members

strategy

object | null

An object that specifies how the rotation's on-call shifts should be generated.

restrictions

array of objects | null

A list of objects that restrict the rotation to specific on-call periods.

restrictions

start_time

string | null

An ISO8601 time string specifying when the initial rotation should start. This value is only used if the rotation's strategy type is "custom".

effective_at

string | null

An ISO8601 time string specifying when the updated schedule should take effect. This value must be provided if editing an attribute that would affect how the schedule's shifts are generated, such as the time zone, members, strategy, or restrictions.

from

string | null

An ISO8601 time string specifying the start of the time window to preview. Defaults to now.

string | null

An ISO8601 time string specifying the end of the time window to preview. Defaults to two weeks from now.

Response

201Preview a new on-call rotation orchanges to an existing on-call rotation