Schedules - incident.io

View and manage schedules. Manage your full schedule of on-call rotations, including the users and rotation configuration.

The schedule object

annotations

object

required

Annotations that track metadata about this resource

Show child attributes

Example:

{ "incident.io/terraform/version": "3.0.0" }

created_at

string<date-time>

required

Example:

"2021-08-17T13:28:57.801578Z"

string

required

Unique internal ID of the schedule

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

name

string

required

Human readable name synced from external provider

Example:

"Primary On-Call Schedule"

team_ids

string[]

required

IDs of teams that own this schedule

Example:

["01JPQA75EPNEES4479P16P4XAB"]

timezone

string

required

Timezone of the schedule, as interpreted at the point of generating the report

Example:

"Europe/London"

updated_at

string<date-time>

required

Example:

"2021-08-17T13:28:57.801578Z"

config

object

Show child attributes

Example:

{
  "rotations": [
    {
      "effective_from": "2021-08-17T13:28:57.801578Z",
      "handover_start_at": "2021-08-17T13:28:57.801578Z",
      "handovers": [
        { "interval": 1, "interval_type": "hourly" }
      ],
      "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "layers": [
        {
          "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
          "name": "Layer 1"
        }
      ],
      "name": "Primary On-Call Schedule",
      "scheduling_mode": "fair",
      "users": [
        {
          "email": "lisa@incident.io",
          "id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "name": "Lisa Karlin Curtis",
          "role": "owner",
          "slack_user_id": "U02AYNF2XJM"
        }
      ],
      "working_interval": [
        {
          "end_time": "17:00",
          "start_time": "09:00",
          "weekday": "monday"
        }
      ],
      "working_intervals": [
        {
          "end_time": "17:00",
          "start_time": "09:00",
          "weekday": "monday"
        }
      ]
    }
  ]
}

current_shifts

object[]

Shifts that are ongoing for this schedule

Show child attributes

Example:

[
  {
    "end_at": "2021-08-17T13:28:57.801578Z",
    "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH",
    "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "start_at": "2021-08-17T13:28:57.801578Z",
    "user": {
      "email": "lisa@incident.io",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Lisa Karlin Curtis",
      "role": "owner",
      "slack_user_id": "U02AYNF2XJM"
    }
  }
]

holidays_public_config

object

Show child attributes

Example:

{ "country_codes": ["GB", "FR"] }

next_shifts

object[]

The shifts after the next changeover. Note that on the list schedules endpoint, this will always be empty if the page size requested is greater than 25.

Show child attributes

Example:

[
  {
    "end_at": "2021-08-17T13:28:57.801578Z",
    "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH",
    "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "start_at": "2021-08-17T13:28:57.801578Z",
    "user": {
      "email": "lisa@incident.io",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Lisa Karlin Curtis",
      "role": "owner",
      "slack_user_id": "U02AYNF2XJM"
    }
  }
]

Update

List

⌘I

{
  "annotations": {
    "incident.io/terraform/version": "3.0.0"
  },
  "created_at": "2021-08-17T13:28:57.801578Z",
  "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
  "name": "Primary On-Call Schedule",
  "team_ids": [
    "01JPQA75EPNEES4479P16P4XAB"
  ],
  "timezone": "Europe/London",
  "updated_at": "2021-08-17T13:28:57.801578Z",
  "config": {
    "rotations": [
      {
        "effective_from": "2021-08-17T13:28:57.801578Z",
        "handover_start_at": "2021-08-17T13:28:57.801578Z",
        "handovers": [
          {
            "interval": 1,
            "interval_type": "hourly"
          }
        ],
        "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
        "layers": [
          {
            "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
            "name": "Layer 1"
          }
        ],
        "name": "Primary On-Call Schedule",
        "scheduling_mode": "fair",
        "users": [
          {
            "email": "lisa@incident.io",
            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "name": "Lisa Karlin Curtis",
            "role": "owner",
            "slack_user_id": "U02AYNF2XJM"
          }
        ],
        "working_interval": [
          {
            "end_time": "17:00",
            "start_time": "09:00",
            "weekday": "monday"
          }
        ],
        "working_intervals": [
          {
            "end_time": "17:00",
            "start_time": "09:00",
            "weekday": "monday"
          }
        ]
      }
    ]
  },
  "current_shifts": [
    {
      "end_at": "2021-08-17T13:28:57.801578Z",
      "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH",
      "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "start_at": "2021-08-17T13:28:57.801578Z",
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "owner",
        "slack_user_id": "U02AYNF2XJM"
      }
    }
  ],
  "holidays_public_config": {
    "country_codes": [
      "GB",
      "FR"
    ]
  },
  "next_shifts": [
    {
      "end_at": "2021-08-17T13:28:57.801578Z",
      "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH",
      "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "start_at": "2021-08-17T13:28:57.801578Z",
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "owner",
        "slack_user_id": "U02AYNF2XJM"
      }
    }
  ]
}

​The schedule object

The schedule object