WorkWhile API lets you request high-quality, reliable workforce.

The core entity at WorkWhile is a Shift - essentially the listing for a specific job. It contains details like location, start time, end time, pay, job description and number of workers.

To request workers, all you need to do is create a Shift. Once a Shift is created, all eligible workers are notified and see this shift in their apps. As workers accept your shift, you receive webhook updates with worker details.

Creating your first shift

First step to creating a Shift is creating a CompanyLocation. This is the location where you want workers to report. You will need to supply coordinates (latitude, longitude) and a name for this location. Once location creation succeeds it will return a location ID which you should note down.

Next, you need to create a CompanyPosition. This contains details of the job the worker will be expected to perform. It takes in a free-form text description and a name. Position creation returns an ID which you need to store on your end.

Now you can create a Shift by making a create_shift POST request with you position id, location id, number of workers, pay rate, start time and end time.

From here your shift will be surfaced to eligible workers. As they accept, you will receive onShiftWorkEvent webhooks which contain workers name and contact details. You will also receive onShiftWorkEvents events with status = started when a worker clocks in, status = completed when they clock out and status = paid when they receive payments.

Testing in Sandbox

WorkWhile provides a sandbox where you can create test shifts and get matched up with test workers (bots). This allows you to test the entire lifecycle of a shift.