Understanding the request

We will now show how we represent schedules so that you can transform your schedule into a request that we can assign shifts to. At the top level, your POST request will only contain these fields:

{
  "employees": [],
  "shifts": [],
  "spots": [],
  "callbackUrl": "https://www.yourdomain.app/custom_callback_url",
  "callbackAuthenticationHeaderName": "X-Api-Key",
  "callbackAuthenticationHeaderValue": "SECRET"
}

If you want to skip the details, you can jump straight to an example of a full payload

Employees

Sit commodi iste iure molestias qui amet voluptatem sed quaerat. Nostrum aut pariatur. Sint ipsa praesentium dolor error cumque velit tenetur.

For more information, see the chapter on employees.

Shifts

For more information, see the chapter on shifts.

Spots

You might For more information, see the chapter on shifts.

Callback

Solving a

Oh no! I do not have a web-facing server to handle callbacks

This is what a disclaimer message looks like. You might want to include inline code in it. Or maybe you’ll want to include a link in it. I don’t think we should get too carried away with other scenarios like lists or tables — that would be silly.

For more information, see the chapter on settings.