Back to Home

Schedule configuration

A Schedule defines an on-call rotation for a Team: who is on call, in what order, how escalation works, and how VoIP calls behave. A Schedule belongs to a Team, so create the Team first.

Core fields

FieldTypeRequiredDefaultNotes
namestringYesSchedule name. Cannot be empty.
timezonestringNoOrg settingIANA timezone (e.g. Asia/Tokyo). If omitted, empty, or UTC, the Organization's timezone is used.
descriptionstringNo""Free-text description. Up to 500 characters.
labelsarrayNo[]List of string labels.
investigation_hintsstringNoOptional free-text hints shown to responders.
rotation_periodstringYesOne of manual, daily, weekly, biweekly, monthly.
rotation_timeout_secondsnumberYesSeconds to wait for a responder before moving on. Range: 30–300.
rotation_roundsnumberYesHow many rounds to attempt. Range: 1–5.
final_escalation_user_emailstringNoEmail of the user notified as the final escalation. Resolved against the Team's members.
membersarrayYesAt least one member. Each entry is { user_id, rotation_order } or { user_email, rotation_order }. Members must belong to the Team.
configurationsarrayNo[]Overlay schedules with their own date ranges. Up to 10; date ranges must not overlap; each overlay needs at least one member.

For members, identify the user by user_id or user_email (email takes precedence). The final-escalation user and all members must be members of the Team.

Each configurations overlay entry takes a required effective_date (start, YYYY-MM-DD), an optional end_date, and its own members list (same shape as the base members above).

VoIP call behavior

These optional fields control how the automated VoIP call to the on-call responder behaves.

FieldTypeRequiredDefaultNotes
voip_skip_confirmationbooleanNoSkip the confirmation step on the call.
voip_compact_guidancebooleanNoUse shorter spoken guidance.
voip_transcript_enabledbooleanNoEnable call transcript.
voip_input_modestringNoInput modality: voice_and_dtmf or dtmf_only.
voip_barge_inbooleanNoAllow barge-in (full duplex). When voice input is enabled and barge-in is on, the confirmation step cannot be disabled.
voip_confirm_retry_interval_secondsnumberNo8Wait time (seconds) before re-prompting in confirmation mode. Range: 3–60 (default 8).
voip_confirm_max_retriesnumberNo2Maximum re-prompts in confirmation mode. Range: 1–5 (default 2).
flapping_escalation_enabledbooleanNofalseWhen ON, the server detects call flapping (caller repeatedly reconnects) and escalates to the next member early without waiting for the response timeout. Default OFF (opt-in).
reconnect_window_secondsnumberNo30Sliding window in seconds for counting reconnects to detect flapping. Range: 10–300 (default 30).
flapping_reconnect_thresholdnumberNo3Number of reconnects within the window (initial connect is not counted) that triggers early escalation. Range: 2–10 (default 3).