Reference

Reference for jobs' actions.

Update Job Progress

POST /queues/:queue-name/jobs/:job-id/progress

Updates the progress of a given job. The progress can be a number or any other json serializable object.

Note, the token used as bearer token must be the token received on the worker's endpoint specific for a given job.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <job-token>

Body

An integer or any JSON serializable object.

Response

200

OK

400

Add Job Logs

POST /queues/:queue-name/jobs/:job-id/logs

Add a log to a given job. Any number of logs can be added to a given job.

Note, the token used as bearer token must be the token received on the worker's endpoint specific for a given job.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <job-token>

Body

A plain string with the message to add as a log.

Response

200

OK

400

Get Job Logs

GET /queues/:queue-name/jobs/:job-id/logs?start=0&length=10

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Query

Name	Type	Description
start	number	First log to return
length	number	Number of logs to return

Response

200

{
  "count": number,
  "logs": string[],
}

400