API Reference
Contact Support

Preview a new on-call schedule for a team

post
https://api.firehydrant.io/v1/teams//on_call_schedules/preview

Preview a new on-call schedule based on the provided rotations, allowing you to see how the schedule will look before saving it.

Path Params
string
required
Body Params
string
required

The on-call schedule's name.

string | null

A detailed description of the on-call schedule.

rotations
array of objects
required

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*
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

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago