Create an on-call schedule for a team

post

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

Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

string

required

Body Params

name

string

required

The on-call schedule's name.

description

string | null

A detailed description of the on-call schedule.

rotations

array of objects | null

An array of objects that specify rotations for the schedule. If not provided, the deprecated single-rotation parameters can be used instead, with time_zone and strategy being required.

rotations

rotation_name

string | null

An optional name for the initial rotation. If not provided, the schedule's name will be used.

rotation_description

string | null

An optional description for the initial rotation. If not provided, the schedule's description will be used.

color

string | null

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

time_zone

string | null

The time zone in which the on-call schedule's rotation will operate. This value must be a valid IANA time zone name and must be provided if rotations is not.

slack_user_group_id

string | null

The ID of a Slack user group to sync the initial rotation's on-call members to.

members

array of objects | null

An ordered list of objects that specify members of the initial rotation.

members

strategy

object | null

An object that specifies how the initial rotation's on-call shifts should be generated. This value must be provided if rotations is not.

restrictions

array of objects | null

A list of objects that restrict the initial 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".

member_ids

array of strings | null

This parameter is deprecated; use members instead.

member_ids

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later.