HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
These docs are for v2017-01-01. Click to read the latest docs for v2018-06-26.

Introduction

A job is essentially any background work that Xola is doing for a particular seller. The /api/jobs endpoints will allow you to fetch all the jobs for this seller and check on their status.

A job is created when there is any change done that requires extensive processing which cannot be completed in the lifecycle of an HTTP request. For example, when a seller modifies a schedule it has the potential to affect one or more trips & the dashboard too, therefore Xola will create a job to check and update availability for all affected trips.

Status

The following statuses are available for a job:

StatusMeaning
newThe job was added to the queue but has not been picked up by a worker.
processingThe job is being processed right now.
completedThe job has finished processing and any necessary changes have been made.
errorThe job failed & error'ed out.
staleThe job has been running too long and has timed out. It may or may not have finished all necessary tasks. This should rarely happen.