Cron Triggers

​​ Background

Cron Triggers allow users to map a cron expression to a Worker using a scheduled() handler that enables Workers to be executed on a schedule.

Cron Triggers are ideal for running periodic jobs, such as for maintenance or calling third-party APIs to collect up-to-date data. Workers scheduled by Cron Triggers will run on underutilized machines to make the best use of Cloudflare’s capacity and route traffic efficiently.

Cron Triggers execute on UTC time.

​​ Add a Cron Trigger

​​ 1. Define a scheduled event listener

To respond to a Cron Trigger, you must add a "scheduled" handler to your Worker.

Refer to the following examples to write your code:

• Setting Cron Triggers
• Multiple Cron Triggers

​​ 2. Update configuration

After you have updated your Worker code to include a "scheduled" event, you must update your Worker project configuration.

​​ Via wrangler.toml

If a Worker is managed with Wrangler, Cron Triggers should be exclusively managed through the wrangler.toml file.

Refer to the example below for a sample wrangler.toml Cron Triggers configuration:

[triggers]
# Schedule cron triggers:
# - At every 3rd minute
# - At 3PM on first day of the month
# - At 11:59PM on the last weekday of the month
crons = [ "*/3 * * * *", "0 15 1 * *", "59 23 LW * *" ]

You also can set a different Cron Trigger for each environment in your wrangler.toml. You need to put the [triggers] table under your chosen environment. For example:

[env.dev.triggers]
crons = ["0 * * * *"]

​​ Via the dashboard

To add Cron Triggers in the Cloudflare dashboard:

1. Log in to the Cloudflare dashboard Open external link and select your account.
2. In Account Home, select Workers & Pages.
3. In Overview, select your Worker > Triggers > Cron Triggers.

​​ Supported cron expressions

Cloudflare supports cron expressions with five fields, along with most Quartz scheduler Open external link -like cron syntax extensions:

​​ Examples

Some common time intervals that may be useful for setting up your Cron Trigger:

​​ Test Cron Triggers

The recommended way of testing Cron Triggers is using Wrangler.

Test Cron Triggers using Wrangler by passing in the --test-scheduled flag to wrangler dev. This will expose a /__scheduled route which can be used to test using a HTTP request. To simulate different cron patterns, a cron query parameter can be passed in.

$ wrangler dev --test-scheduled

$ curl "http://localhost:8787/__scheduled?cron=*+*+*+*+*"

​​ View past events

Users can review the execution history of their Cron Triggers in Past Cron Events under Logs Open external link or through Cloudflare’s GraphQL Analytics API.

Refer to Metrics and Analytics for more information.

​​ Remove a Cron Trigger

​​ Via the dashboard

To delete a Cron Trigger on a deployed Worker via the dashboard:

1. Log in to the Cloudflare dashboard Open external link and select your account.
2. Go to Workers & Pages, and select your Worker.
3. Go to Triggers > select the three dot icon next to the Cron Trigger you want to remove > Delete.

​​ Via wrangler.toml

To disable a Cron Trigger on a deployed Worker, set crons = []. Commenting out the crons key will not disable a Cron Trigger.

​​ Limits

Refer to Limits to track the maximum number of Cron Triggers per Worker.

​​ Green Compute

With Green Compute enabled, your Cron Triggers will only run on Cloudflare points of presence that are located in data centers that are powered purely by renewable energy. Organizations may claim that they are powered by 100 percent renewable energy if they have procured sufficient renewable energy to account for their overall energy use.

Renewable energy can be purchased in a number of ways, including through on-site generation (wind turbines, solar panels), directly from renewable energy producers through contractual agreements called Power Purchase Agreements (PPA), or in the form of Renewable Energy Credits (REC, IRECs, GoOs) from an energy credit market.

​​ Related resources

• Triggers - Review wrangler.toml syntax for Cron Triggers.