Ensure you have the necessary permissions in your on-call product to establish an API connection with On-Call Optimizer.
Intended results
Completing the steps in this guide will result in:
Creation of a new On-Call Optimizer schedule linked to your existing schedule.
Configuration of the new On-Call Optimizer schedule to begin assigning new shifts from a future date.
(optionally) Each member of the schedule will be invited to share their calendar(s) with On-Call Optimizer.
(optionally) Future shifts assigned by On-Call Optimizer will be automatically exported back to your existing schedule.
If you do not opt-in to send invitations or enable automatic shift export linking an existing schedule to On-Call Optimizer will not affect the operation of your existing schedule in any way.
Begin
To get started, select Connect an On-Call Product below.
1 - Connect an On-Call Product
In this step we will establish a connection between On-Call Optimizer and the On-Call Product
you are currently using to manage the on-call schedule you have chosen to link with On-Call Optimizer.
3. Select your product and configure authentication
Click on the logo of the product you wish to connect to.
Enter your API Key in the provided field and click Continue
Screencast
Next Steps
Once you have configured an API key, On-Call Optimizer will begin the process of connecting to the chosen product and collecting details of the available schedules. This may take a couple of minutes during which you will see a loading spinner.
Click below to begin reading the next steps while the connection is created.
In this step you will select which of the schedules available in the On-Call Product
you connected to should be linked with On-Call Optimizer.
Use the drop-down arrow within each schedule to expand the list of members and see the shift times for the schedule inferred from the
existing configuration.
Create On-Call Optimizer Schedule
Once you have identified which of the listed schedules you wish to continue linking, click the Create On-Call Optimizer Schedule link (on the right of the box on desktop, or the bottom on mobile/tablet).
Next Steps
When you click the create link, a new draft schedule linked to the existing schedule from your On-Call Product will be created within On-Call Optimizer. In the next step you will have the opportunity to configure and customize the new schedule before confirming the link.
In these steps you have the opportunity to customize and then confirm the configuration of the schedule that On-Call Optimizer will use.
Confirm configuration
On-Call Optimizer will show the time zone and shift configuration that have been detected from the source On-Call Product.
If the listed shifts do not match your desired configuration you can alter them now or at a lateer time. Refer to the detailed
schedule configuration docs for further details.
Once you are happy with the configuration shown, click Continue to proceed to the next step.
Member list
In the second step, On-Call Optimizer will show the list of members that have been imported from the source On-Call Product.
On this screen you can customize which of the member will be assignable in the schedule, their role and associated permissions and whether
or not to send any required invitation emails when the schedule is created. Refer to the schedule members docs
for further details.
When you are happy with the list of members and their configuration, click Create to finish linking the schedule. If required and enabled, On-Call Optimizer
will send any invitations to the members of the schedule and begin monitoring the assignments, ready to assign new shifts as required.
Congratulations. You have successfully imported your existing schedule into On-Call Optimizer!
To get the most out of On-Call Optimizer, we recommend continuing with the following documentation topics:
