Schedules

A Schedule is a Job that Coderunner starts for you on a timetable. Use it for daily reports, periodic imports, data syncs, cleanups and notifications.

Write the handler

A Schedule uses the same handler as a Job. Its payload is usually empty, so read any settings from environment variables or your own code:

const handler = async (context, payload) => {
  const region = process.env.REPORT_REGION ?? "all";
  await sendDailyReport(region);
  console.log(`Daily report sent for ${region}`);
};

module.exports = { handler };

Set the timetable

A timetable is a cron expression: five fields for minute, hour, day of month, month and day of week. Times are in UTC.

Deploy it

gf deploy --name daily-report --workload-type schedule --schedule "0 9 * * *"

{
  "name": "daily-report",
  "runtime": "node",
  "workloadType": "schedule",
  "schedule": "0 9 * * *"
}

Check that it's running

A Schedule has no public URL. To see its timetable and how its last run went:

• Client Portal: open the Coderunner. Its runs and their output are in Observe → Process Log.
• CLI: gf coderunner status -c daily-report prints the type, the timetable and the last run's status: succeeded, failed or running.

Next steps

• Jobs — how a run succeeds or fails.
• Configuration and secrets — give your Schedule settings and secrets.
• Logs and troubleshooting — investigate a failed run.