Automations

Schedule (cron) or event triggers that run a suite or a load test.

An automation runs an action when a trigger fires. A trigger is either a schedule (a cron expression, evaluated in an optional timezone) or an event (a run finishing — optionally gated to a status such as failed). An action runs a suite of features (run_features) or a load test (run_load). Every firing is recorded with its outcome (dispatched / skipped / error) and a link to the produced run.

Automations call the same dispatch path as run_suite and run_load_test — a fired automation produces an ordinary run you read back with the runs operations.

Operation	What it does
list_automations	List the project's automations.
get_automation	Read one automation.
create_automation	Create an automation.
update_automation	Update an automation (or pause it).
delete_automation	Delete an automation and its history.
run_automation	Fire an automation now (manual trigger).
list_automation_runs	One automation's firing history.

The automation object

{
  "id": "a1b2c3d4-0000-0000-0000-000000000000",
  "name": "Nightly smoke suite",
  "enabled": true,
  "trigger": { "type": "schedule", "cron": "0 8 * * *", "tz": "America/New_York" },
  "action": { "type": "run_features", "featureIds": [12, 15], "configName": "Default" },
  "condition": null,
  "nextDueUtc": "2026-06-16T12:00:00.0000000Z",
  "lastTriggeredUtc": null,
  "createdUtc": "2026-06-15T18:00:00.0000000Z",
  "updatedUtc": null
}

Field	Notes
id	The automation's public id — the handle in every route.
trigger.type	schedule (uses cron, optional tz) or event (uses kind, optional filter).
action.type	run_features (uses featureIds — omit for the whole generated suite — plus optional configName) or run_load (uses featureId, the load-test feature).
condition	Optional gate, e.g. { "status": "failed" }; null = always fire.
nextDueUtc	Schedule triggers only: the scheduler's next fire time, computed from the cron.

The schedule → fire pattern is described in Long-running operations.