Getting started

Shiftkeeper docs

Introduction

A brief overview of the core concepts in Shiftkeeper

Core Concepts

View your on-call shifts and export them to your calendar app

On-call shifts

Request shift coverage from teammates without the back-and-forth

Coverage

Teams

Versions

Understanding API errors and status codes

Errors

List schedules

Create a schedule

Get a schedule

Delete a schedule. This also removes the attached Slack user group, if there is one.

Delete a schedule

Update a schedule. Changes to the schedule rotation settings do not affect shifts which have already finished.

Update a schedule

List all shifts for a schedule within a given time interval.

List schedule shifts

Get the Slack user group attached to the schedule.

Get the Slack user group for a schedule

Attach a Slack user group to a schedule. If the schedule already has a Slack user group attached, it will be updated.

Note that user groups are available only in paid Slack plans.

Attach or update the Slack user group for a schedule

Detach the Slack user group from a schedule. The user group will be disabled, as Slack does not allow deleting user groups. If you attach a user group to the schedule in the future, the user group will be reused and re-enabled.

Detach the Slack user group from a schedule

List all Slack channels linked to a schedule.

List linked schedule Slack channels

Link a Slack channel to a schedule. Shift and schedule related notifications will be sent to the channel.

Currently only public channels are supported.

Link a Slack channel to a schedule

Unlink a Slack channel from a schedule. Once unlinked, schedule notifications will no longer be sent to that channel.

Unlink a Slack channel from a schedule

List all schedule overrides in your organization.

List schedule overrides

Override a schedule shift

Get a schedule override

Delete a schedule override. Overrides that have already finished cannot be deleted.

Delete a schedule override

List all coverage requests in your organization.

List coverage requests

Get a coverage request

Take an action on a coverage request. The coverage request must be in `pending` state.

Accept or decline a coverage request

List all coverage requests for the authenticated user.

List coverage requests for the authenticated user

Create a new coverage request for the authenticated user.

Request coverage

Cancel a coverage request for the authenticated user. The coverage request must be in `pending` state.

Cancel a coverage request

List all on-call shifts from all schedules of the authenticated user.

List on-call shifts for the authenticated user

Get the authenticated user who owns this API key.

Get the authenticated user

List users

Get a user

List teams

Create a team

Get a team

Delete a team. Deleting a team does not remove the linked schedules.

Delete a team

Update a team

List team members

Check if a user is a member of a team. A `204` response indicates that the user is a member of the team.

Getting Started

Using Shiftkeeper

API

Getting started

Getting Started

Using Shiftkeeper

​Getting started

Getting started