Encore Go Cron Jobs

Instructions

cron.NewJob

//encore:api

package cleanup

import (
    "context"
    "encore.dev/cron"
)

// 1. The endpoint to call (typically private: //encore:api private)
//encore:api private
func CleanupExpiredSessions(ctx context.Context) error {
    // Cleanup logic
    return nil
}

// 2. Package-level cron declaration
var _ = cron.NewJob("cleanup-sessions", cron.JobConfig{
    Title:    "Clean up expired sessions",
    Schedule: "0 * * * *", // Every hour
    Endpoint: CleanupExpiredSessions,
})

Schedule Formats

Every

"1h"

"30m"

"6h"

"7h"

Schedule

"0 9 * * 1"

Common cron expressions

"0 * * * *"

"0 2 * * *"

"0 0 * * 0"

"0 4 15 * *"

Important behaviour

• Cron jobs do not execute when running locally with

  encore run

  . Only deployed environments fire crons.
• The cron endpoint should be

  private

  so it can't be triggered externally — only the cron scheduler should call it.
• All times in

  Schedule

  are UTC. Convert from local time when designing the schedule.
• The endpoint must be defined at module load — declare it before the

  cron.NewJob

  reference.

Guidelines

• Use

  Every

  for "run on a regular interval" (must divide 24h).
• Use

  Schedule

  for specific times of day or days of week.
• Keep endpoint logic idempotent: a cron may fire late or be retried in a redeploy window.
• For event-driven background work (not time-driven), use the

  encore-go-pubsub

  skill instead.