Cron jobs

next-forge uses Vercel's cron jobs feature to trigger Next.js serverless functions on a schedule.

Writing functions

Next.js serverless functions act as the basis for scheduled jobs. You can write them in any runtime and trigger them using a simple HTTP call.

To demonstrate, we've created a example endpoint called keep-alive that creates, then subsequently deletes, a temporary page object in the database. This is a little workaround to prevent databases going to sleep after a period of inactivity. You should probably remove this if you don't need it.

Additionally, while you can add cron jobs to any app, we use the api app to keep our background jobs, webhooks and other such tasks isolated from our UI.

You can add new functions by creating the relevant route.ts files in the apps/api/app/cron folder. While you can put them anywhere, we use the aptly named cron folder to hold our endpoints designed to run as cron jobs. For example:

import { database } from '@repo/database';
 
export const POST = async () => {
  // Do stuff
 
  return new Response('OK', { status: 200 });
};

Scheduling functions

After you write your serverless function, you can schedule it by amending the vercel.json file in the API app. To serve as an example, we've wired up the keep-alive job mentioned above to run every 10 minutes.

{
  "crons": [
    {
      "path": "/cron/keep-alive",
      "schedule": "*/10 * * * *"
    }
  ]
}

Triggering functions manually

Should you need to trigger a cron job manually, you can either do so in the Vercel dashboard or just hit the endpoint with a standard HTTP request. For example:

curl -X POST http://localhot:3002/cron/keep-alive