Cron jobs - Pxxl

Create a cron job

string

required

Name shown in Pxxl.

string

required

Five-field cron expression such as */5 * * * *.

string

required

HTTPS endpoint called by the job.

GET | POST | PUT | PATCH | DELETE

default:"GET"

HTTP method used for the request.

object

Request headers sent to the endpoint.

number

Maximum execution time.

string

Project associated with the job.

string

Team that owns the job.

Node.js
Go
Python
Rust

const job = await pxxl.cron.create({
  name: "cache warmer",
  schedule: "*/5 * * * *",
  url: "https://example.com/jobs/warm",
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.JOB_TOKEN}` },
  timeoutSeconds: 30,
});

job, err := client.CreateCronJob(ctx, pxxl.CreateCronJobInput{
  Name: "cache warmer", Schedule: "*/5 * * * *",
  URL: "https://example.com/jobs/warm", Method: "POST",
  TimeoutSeconds: 30,
})

job = client.create_cron_job(
    name="cache warmer", schedule="*/5 * * * *",
    url="https://example.com/jobs/warm", method="POST",
    timeout_seconds=30,
)

let job = client.create_cron_job(CreateCronJob {
    name: "cache warmer".into(), schedule: "*/5 * * * *".into(),
    url: "https://example.com/jobs/warm".into(),
    method: Some("POST".into()), timeout_seconds: Some(30),
    ..Default::default()
}).await?;

Returns

{
  "id": "cron_123",
  "name": "cache warmer",
  "schedule": "*/5 * * * *",
  "url": "https://example.com/jobs/warm",
  "method": "POST",
  "timeoutSeconds": 30,
  "status": "active",
  "consecutiveFailures": 0,
  "lastRunAt": null,
  "nextRunAt": "2026-08-17T08:10:00Z"
}

Cron operations

Operation	Node.js	Parameters	Returns
List	`cron.list(input?)`	`teamId?`	`{ cronJobs }`
Get	`cron.get(id, teamId?)`	Job ID, `teamId?`	Cron job
Create	`cron.create(input)`	Fields above	Cron job
Update	`cron.update(id, input)`	Any editable create field, `status?`	Updated cron job
Delete	`cron.delete(id, teamId?)`	Job ID, `teamId?`	Action result
Start	`cron.start(id, teamId?)`	Job ID, `teamId?`	Action result
Stop	`cron.stop(id, teamId?)`	Job ID, `teamId?`	Action result
Trigger	`cron.trigger(id, teamId?)`	Job ID, `teamId?`	Accepted run result
Runs	`cron.runs(id, input?)`	`page?`, `limit?`, `teamId?`	`{ runs, total?, page?, limit?, totalPages? }`
Validate schedule	`cron.validateSchedule(schedule)`	Cron expression	Validation result
Validate URL	`cron.validateURL(url)`	HTTPS URL	Validation result

Trigger and read a run

const trigger = await pxxl.cron.trigger("cron_123");
const history = await pxxl.cron.runs("cron_123", { page: 1, limit: 20 });

{
  "runs": [
    {
      "id": "run_123",
      "cronJobId": "cron_123",
      "status": "success",
      "statusCode": 200,
      "output": "ok",
      "error": null,
      "timedOut": false,
      "startedAt": "2026-08-17T08:05:00Z",
      "finishedAt": "2026-08-17T08:05:01Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

Job headers can contain secrets. Keep cron management in trusted server code.

Handle plan limits

Plan and resource-limit responses include structured fields. Use the SDK helper instead of parsing response text or hardcoding plan limits.

Node.js
Go
Python
Rust

import { isPlanGateError } from "@pxxlapp/pxxl";

try {
  await pxxl.cron.create({
    name: "invoice reconciliation",
    schedule: "*/10 * * * *",
    url: "https://api.example.com/jobs/reconcile-invoices",
    method: "POST",
  });
} catch (error) {
  if (isPlanGateError(error)) {
    console.log(error.code, error.limit, error.current, error.requiredPlan);
  }
}

var apiErr *pxxl.APIError
if errors.As(err, &apiErr) && apiErr.IsPlanGate() {
  log.Println(apiErr.Code, apiErr.Limit, apiErr.Current, apiErr.RequiredPlan)
}

from pxxl import is_plan_gate_error

if is_plan_gate_error(error):
    print(error.code, error.limit, error.current, error.required_plan)

if error.is_plan_gate() {
    eprintln!("The current plan cannot create another cron job");
}

​Create a cron job

​Cron operations

​Trigger and read a run

​Handle plan limits

Create a cron job

Cron operations

Trigger and read a run

Handle plan limits