Run Job

POST {{base_url}}/org/:org_id/runner/job/:job_id/run

Run a job. This will add the job to the queue.

Run a job with variables

Users have the option to pass variables to the job. For example if you want to use page as variable in the job, in the api call, set option.page as some value. This will make sure the job gets page as variable.

To use page in your scripts, if you are using this variable in terminal then you will have to specify it as so

node do_something.js --page=@option.page@

Schedule a job

You can trigger the job to run a later date. Send a valid timestamp in ISO format to run_at

Request Body

[{"name"=>"option.page", "value"=>"{{page}}", "datatype"=>"string"}, {"name"=>"option.filter_mode", "value"=>"first_created", "datatype"=>"string"}, {"name"=>"option.limit", "value"=>"100", "datatype"=>"number"}, {"name"=>"option.days_before", "value"=>"", "datatype"=>"null"}, {"name"=>"option.working_sheet", "value"=>"{{working_sheet}}", "datatype"=>"string"}, {"name"=>"delay", "value"=>"deprecated", "datatype"=>"string"}, {"name"=>"backoff", "value"=>"deprecated", "datatype"=>"string"}, {"name"=>"run_at", "value"=>"deprecated", "datatype"=>"string"}]

HEADERS

RESPONSES

status: OK

{"status":"Added to queue","delay":"10000","backoff":"10000","avg_run_time":60000}