Tasks

You can register Tasks on the Payload config, and then create Jobs or Workflows that use them. Think of Tasks like tidy, isolated "functions that do one specific thing".

Payload Tasks can be configured to be automatically retried if they fail, which makes them valuable for "durable" workflows like AI applications where LLMs can return non-deterministic results, and might need to be retried.

Tasks can either be defined within the jobs.tasks array in your Payload config, or they can be defined inline within a workflow.

Defining tasks in the config

Simply add a task to the jobs.tasks array in your Payload config. A task consists of the following fields:

Option	Description
`slug`	Define a slug-based name for this job. This slug needs to be unique among both tasks and workflows.
`handler`	The function that should be responsible for running the job. You can either pass a string-based path to the job function file, or the job function itself. If you are using large dependencies within your job, you might prefer to pass the string path because that will avoid bundling large dependencies in your Next.js app. Passing a string path is an advanced feature that may require a sophisticated build pipeline in order to work.
`inputSchema`	Define the input field schema - Payload will generate a type for this schema.
`interfaceName`	You can use interfaceName to change the name of the interface that is generated for this task. By default, this is "Task" + the capitalized task slug.
`outputSchema`	Define the output field schema - Payload will generate a type for this schema.
`label`	Define a human-friendly label for this task.
`onFail`	Function to be executed if the task fails.
`onSuccess`	Function to be executed if the task succeeds.
`retries`	Specify the number of times that this step should be retried if it fails. If this is undefined, the task will either inherit the retries from the workflow or have no retries. If this is 0, the task will not be retried. By default, this is undefined.
`concurrency`	Control how jobs with the same concurrency key are handled. Jobs with the same key will run exclusively (one at a time). Requires `jobs.enableConcurrencyControl: true` to be set. See Concurrency Controls for details.
`schedule`	Define one or more schedules to automatically queue this task periodically. Each schedule requires a `cron` expression and a `queue` name. See Job Schedules for complete documentation.

The logic for the Task is defined in the handler - which can be defined as a function, or a path to a function. The handler will run once a worker picks up a Job that includes this task.

It should return an object with an output key, which should contain the output of the task as you've defined.

Example:

1export default buildConfig({
// ...
jobs: {
  tasks: [
    {
      // Configure this task to automatically retry
      // up to two times
      retries: 2,
9
      // This is a unique identifier for the task
11
      slug: 'createPost',
13
      // These are the arguments that your Task will accept
      inputSchema: [
        {
          name: 'title',
          type: 'text',
          required: true,
        },
      ],
22
      // These are the properties that the function should output
      outputSchema: [
        {
          name: 'postID',
          type: 'text',
          required: true,
        },
      ],
31
      // This is the function that is run when the task is invoked
      handler: async ({ input, job, req }) => {
        const newPost = await req.payload.create({
          collection: 'post',
          req,
          data: {
            title: input.title,
          },
        })
        return {
          output: {
            postID: newPost.id,
          },
        }
      },
    } as TaskConfig<'createPost'>,
  ],
},
50})

Scheduling Tasks to Run Automatically

Tasks can be configured to run automatically on a schedule by adding the schedule property. This is useful for recurring operations like daily reports, periodic syncs, or scheduled cleanups.

How it works:

The schedule property automatically queues jobs at specified times (no need to call payload.jobs.queue() manually)
You still need to configure a job runner (like autoRun) to execute the queued jobs
Both the schedule and runner must use the same queue name

Example:

1export default buildConfig({
jobs: {
  tasks: [
    {
      slug: 'dailyDigest',
6
      // This automatically queues the task every day at 8 AM
      schedule: [
        {
          cron: '0 8 * * *', // Every day at 8:00 AM
          queue: 'daily', // Queue to add the job to
        },
      ],
14
      inputSchema: [
        {
          name: 'date',
          type: 'date',
        },
      ],
21
      handler: async ({ req, input }) => {
        // Send daily digest emails
        const users = await req.payload.find({
          collection: 'users',
          where: { subscribed: { equals: true } },
        })
28
        for (const user of users.docs) {
          await req.payload.sendEmail({
            to: user.email,
            subject: 'Your Daily Digest',
            html: generateDigestHTML(user),
          })
        }
36
        return {
          output: {
            emailsSent: users.docs.length,
            date: input.date || new Date().toISOString(),
          },
        }
      },
    } as TaskConfig<'dailyDigest'>,
  ],
46
  // Important: You also need to configure a runner to execute scheduled jobs
  autoRun: [
    {
      cron: '* * * * *', // Check for jobs every minute
      queue: 'daily', // Process jobs from 'daily' queue
      limit: 10,
    },
  ],
},
56})

Key Points:

The schedule property automatically calls payload.jobs.queue() for you on the specified schedule
You can define multiple schedules per task by adding more objects to the schedule array
The cron field uses standard cron syntax (minute, hour, day, month, day-of-week)
Both schedule.queue and autoRun.queue must match for jobs to run
Scheduling is handled automatically by Payload's scheduler—no manual intervention needed

Common cron patterns:

1// Every hour at minute 0
2schedule: [{ cron: '0 * * * *', queue: 'hourly' }]
3
4// Every day at midnight
5schedule: [{ cron: '0 0 * * *', queue: 'nightly' }]
6
7// Every Monday at 9 AM
8schedule: [{ cron: '0 9 * * 1', queue: 'weekly' }]
9
10// Every 5 minutes
11schedule: [{ cron: '*/5 * * * *', queue: 'frequent' }]
12
13// Every 3 seconds (extended cron syntax with seconds field)
14schedule: [{ cron: '*/3 * * * * *', queue: 'realtime' }]

See Job Schedules for comprehensive scheduling documentation, including hooks, concurrency controls, and troubleshooting.

Common Task Patterns

Database Operations

Creating or updating documents based on other document changes:

1{
slug: 'updateRelatedPosts',
retries: 2,
inputSchema: [
  {
    name: 'categoryId',
    type: 'relationship',
    relationTo: 'categories',
    required: true,
  },
],
handler: async ({ input, req }) => {
  const posts = await req.payload.find({
    collection: 'posts',
    where: {
      category: {
        equals: input.categoryId,
      },
    },
  })
21
  // Update all posts in this category
  for (const post of posts.docs) {
    await req.payload.update({
      collection: 'posts',
      id: post.id,
      data: {
        categoryUpdatedAt: new Date().toISOString(),
      },
    })
  }
32
  return {
    output: {
      postsUpdated: posts.docs.length,
    },
  }
},
39}

External API Calls

Calling third-party services without blocking your API:

1{
slug: 'syncToThirdParty',
retries: 3,
inputSchema: [
  {
    name: 'documentId',
    type: 'text',
    required: true,
  },
],
handler: async ({ input, req }) => {
  const doc = await req.payload.findByID({
    collection: 'documents',
    id: input.documentId,
  })
16
  // Call external API
  const response = await fetch('https://api.example.com/sync', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(doc),
  })
23
  if (!response.ok) {
    throw new Error(`API error: ${response.statusText}`)
  }
27
  return {
    output: {
      synced: true,
      apiResponse: await response.json(),
    },
  }
},
35}

Conditional Failure

Sometimes you want to fail a task based on business logic:

1{
slug: 'processPayment',
retries: 1,
inputSchema: [
  {
    name: 'orderId',
    type: 'text',
    required: true,
  },
],
handler: async ({ input, req }) => {
  const order = await req.payload.findByID({
    collection: 'orders',
    id: input.orderId,
  })
16
  // Intentionally fail if order is already processed
  if (order.status === 'paid') {
    throw new Error('Order already processed')
  }
21
  // Process payment...
23
  return {
    output: {
      paymentId: 'payment-123',
    },
  }
},
30}

Handling Task Failures

Tasks fail by throwing errors. When a task encounters any type of failure—whether it's an unexpected error, a validation issue, or a business logic violation—you should throw an error with a descriptive message.

1handler: async ({ input, req }) => {
const order = await req.payload.findByID({
  collection: 'orders',
  id: input.orderId,
})
6
// Validation failure
if (input.amount !== order.total) {
  throw new Error(
    `Amount mismatch: expected ${order.total}, received ${input.amount}`,
  )
}
13
// Business rule failure
if (order.status === 'cancelled') {
  throw new Error('Cannot process payment for cancelled order')
}
18
// Conditional check
if (order.status === 'paid') {
  throw new Error('Order already processed')
}
23
// Continue processing...
25}

Preventing Job Retries

From within a task or workflow handler, you can prevent the entire job from being retried by throwing a JobCancelledError:

1throw new JobCancelledError('Job was cancelled')

Accessing Failure Information

After a task fails, you can inspect the job to understand what went wrong:

1const job = await payload.jobs.queue({
2  task: 'processPayment',
3  input: { orderId: '123', amount: 100 },
4})
5
6// Run the job
7await payload.jobs.run()
8
9// Check the job status
10const completedJob = await payload.findByID({
11  collection: 'payload-jobs',
12  id: job.id,
13})
14
15// Check if job failed
16if (completedJob.hasError) {
17  // Access the latest error that caused the job to fail
18  console.log(completedJob.error)
19  // This will contain the error message from the thrown error
20
21  // You can also check the job log to find specific tasks that errored
22  // Note: If the job was retried multiple times, there will be multiple erroring tasks in the log
23  const failedTasks = completedJob.log?.filter(
24    (entry) => entry.state === 'failed',
25  )
26}

Understanding Task Execution

When a task runs

The job is picked up from the queue by a worker
The handler function executes with the provided input
If successful, the output is stored and the job completes
If it throws an error, the task will retry (up to retries count)
After all retries are exhausted, the task and job fail

Advanced: Handler File Paths

In addition to defining handlers as functions directly provided to your Payload config, you can also pass an absolute path to where the handler is defined. If your task has large dependencies, and you are planning on executing your jobs in a separate process that has access to the filesystem, this could be a handy way to make sure that your Payload + Next.js app remains quick to compile and has minimal dependencies.

Keep in mind that this is an advanced feature that may require a sophisticated build pipeline, especially when using it in production or within Next.js, e.g. by calling opening the /api/payload-jobs/run endpoint. You will have to transpile the handler files separately and ensure they are available in the same location when the job is run. If you're using an endpoint to execute your jobs, it's recommended to define your handlers as functions directly in your Payload Config, or use import paths handlers outside of Next.js.

In general, this is an advanced use case. Here's how this would look:

payload.config.ts:

1import { fileURLToPath } from 'node:url'
2import path from 'path'
3
4const filename = fileURLToPath(import.meta.url)
5const dirname = path.dirname(filename)
6
7export default buildConfig({
8  jobs: {
9    tasks: [
10      {
11        // ...
12        // The #createPostHandler is a named export within the `createPost.ts` file
13        handler:
14          path.resolve(dirname, 'src/tasks/createPost.ts') +
15          '#createPostHandler',
16      },
17    ],
18  },
19})

Then, the createPost file itself:

src/tasks/createPost.ts:

1import type { TaskHandler } from 'payload'
2
3export const createPostHandler: TaskHandler<'createPost'> = async ({
input,
job,
req,
7}) => {
const newPost = await req.payload.create({
  collection: 'post',
  req,
  data: {
    title: input.title,
  },
})
return {
  output: {
    postID: newPost.id,
  },
}
20}

Configuring task restoration

By default, if a task has passed previously and a workflow is re-run, the task will not be re-run. Instead, the output from the previous task run will be returned. This is to prevent unnecessary re-runs of tasks that have already passed.

You can configure this behavior through the retries.shouldRestore property. This property accepts a boolean or a function.

If shouldRestore is set to true, the task will only be re-run if it previously failed. This is the default behavior.

If shouldRestore is set to false, the task will be re-run even if it previously succeeded, ignoring the maximum number of retries.

If shouldRestore is a function, the return value of the function will determine whether the task should be re-run. This can be used for more complex restore logic, e.g you may want to re-run a task up to X amount of times and then restore it for consecutive runs, or only re-run a task if the input has changed.

Example:

1export default buildConfig({
// ...
jobs: {
  tasks: [
    {
      slug: 'myTask',
      retries: {
        shouldRestore: false,
      },
      // ...
    } as TaskConfig<'myTask'>,
  ],
},
14})

Example - determine whether a task should be restored based on the input data:

1export default buildConfig({
// ...
jobs: {
  tasks: [
    {
      slug: 'myTask',
      inputSchema: [
        {
          name: 'someDate',
          type: 'date',
          required: true,
        },
      ],
      retries: {
        shouldRestore: ({ input }) => {
          if (new Date(input.someDate) > new Date()) {
            return false
          }
          return true
        },
      },
      // ...
    } as TaskConfig<'myTask'>,
  ],
},
26})

Nested tasks

You can run sub-tasks within an existing task, by using the tasks or inlineTask arguments passed to the task handler function:

1export default buildConfig({
// ...
jobs: {
  // It is recommended to set `addParentToTaskLog` to `true` when using nested tasks, so that the parent task is included in the task log
  // This allows for better observability and debugging of the task execution
  addParentToTaskLog: true,
  tasks: [
    {
      slug: 'parentTask',
      inputSchema: [
        {
          name: 'text',
          type: 'text',
        },
      ],
      handler: async ({ input, req, tasks, inlineTask }) => {
        await inlineTask('Sub Task 1', {
          task: () => {
            // Do something
            return {
              output: {},
            }
          },
        })
25
        await tasks.CreateSimple('Sub Task 2', {
          input: { message: 'hello' },
        })
29
        return {
          output: {},
        }
      },
    } as TaskConfig<'parentTask'>,
  ],
},
37})

Was this page helpful?

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Get the resources you need to start building today

Microsoft chose Payload to tell the world about AI.