Tasks: Overview

There are different types of tasks including regular tasks, scheduled tasks, zod tasks and webhook tasks.

​

Hello world task and how to trigger it

Here’s an incredibly simple task:

import { task } from "@trigger.dev/sdk/v3";

//1. You need to export each task
export const helloWorld = task({
  //2. Use a unique id for each task
  id: "hello-world",
  //3. The run function is the main function of the task
  run: async (payload: { message: string }) => {
    //4. You can write code that runs for a long time here, there are no timeouts
    console.log(payload.message);
  },
});

You can trigger this in two ways:

1. From the dashboard using the “Test” feature.
2. Trigger it from your backend code. See the full triggering guide here.

Here’s how to trigger a single run from elsewhere in your code:

import { helloWorldTask } from "./trigger/hello-world";

async function triggerHelloWorld() {
  //This triggers the task and return a handle
  const handle = await helloWorld.trigger({ message: "Hello world!" });

  //You can use the handle to check the status of the task, cancel and retry it.
  console.log("Task is running with handle", handle.id);
}

You can also trigger a task from another task, and wait for the result.

​

Defining a task

The task function takes an object with the following fields.

​

The id field

This is used to identify your task so it can be triggered, managed, and you can view runs in the dashboard. This must be unique in your project – we recommend making it descriptive and unique.

​

The run function

Your custom code inside run() will be executed when your task is triggered. It’s an async function that has two arguments:

1. The run payload - the data that you pass to the task when you trigger it.
2. An object with ctx about the run (Context), and any output from the optional init function that runs before every run attempt.

Anything you return from the run function will be the result of the task. Data you return must be JSON serializable: strings, numbers, booleans, arrays, objects, and null.

​

retry options

A task is retried if an error is thrown, by default we retry 3 times.

You can set the number of retries and the delay between retries in the retry field:

export const taskWithRetries = task({
  id: "task-with-retries",
  retry: {
    maxAttempts: 10,
    factor: 1.8,
    minTimeoutInMs: 500,
    maxTimeoutInMs: 30_000,
    randomize: false,
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

For more information read the retrying guide, or see the SDK reference.

It’s also worth mentioning that you can retry a block of code inside your tasks as well.

​

queue options

Queues allow you to control the concurrency of your tasks. This allows you to have one-at-a-time execution and parallel executions. There are also more advanced techniques like having different concurrencies for different sets of your users. For more information read the concurrency & queues guide.

export const oneAtATime = task({
  id: "one-at-a-time",
  queue: {
    concurrencyLimit: 1,
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

​

machine options

Some tasks require more vCPUs or GBs of RAM. You can specify these requirements in the machine field. For more information read the machines guide.

export const heavyTask = task({
  id: "heavy-task",
  machine: {
    cpu: 2,
    memory: 4,
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

​

init function

This function is called before a run attempt:

export const taskWithInit = task({
  id: "task-with-init",
  init: async (payload, { ctx }) => {
    //...
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

You can also return data from the init function that will be available in the params of the run, cleanup, onSuccess, and onFailure functions.

export const taskWithInitReturn = task({
  id: "task-with-init-return",
  init: async (payload, { ctx }) => {
    return { someData: "someValue" };
  },
  run: async (payload: any, { ctx, init }) => {
    console.log(init.someData); // "someValue"
  },
});

​

cleanup function

This function is called after the run function is executed, regardless of whether the run was successful or not. It’s useful for cleaning up resources, logging, or other side effects.

export const taskWithCleanup = task({
  id: "task-with-cleanup",
  cleanup: async (payload, { ctx }) => {
    //...
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

​

middleware function

This function is called before the run function, it allows you to wrap the run function with custom code. For more information read the guide.

​

onStart function

When a task run starts, the onStart function is called. It’s useful for sending notifications, logging, and other side effects. This function will only be called one per run (not per retry). If you want to run code before each retry, use the init function.

export const taskWithOnStart = task({
  id: "task-with-on-start",
  onStart: async (payload, { ctx }) => {
    //...
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

You can also define an onStart function in your trigger.config.ts file to get notified when any task starts.

import type { TriggerConfig } from "@trigger.dev/sdk/v3";

export const config: TriggerConfig = {
  onStart: async (payload, { ctx }) => {
    console.log("Task started", ctx.task.id);
  },
};

​

onSuccess function

When a task run succeeds, the onSuccess function is called. It’s useful for sending notifications, logging, syncing state to your database, or other side effects.

export const taskWithOnSuccess = task({
  id: "task-with-on-success",
  onSuccess: async (payload, output, { ctx }) => {
    //...
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

You can also define an onSuccess function in your trigger.config.ts file to get notified when any task succeeds.

import type { TriggerConfig } from "@trigger.dev/sdk/v3";

export const config: TriggerConfig = {
  onSuccess: async (payload, output, { ctx }) => {
    console.log("Task succeeded", ctx.task.id);
  },
};

​

onFailure function

When a task run fails, the onFailure function is called. It’s useful for sending notifications, logging, or other side effects. It will only be executed once the task run has exhausted all its retries.

export const taskWithOnFailure = task({
  id: "task-with-on-failure",
  onFailure: async (payload, error, { ctx }) => {
    //...
  },
  run: async (payload: any, { ctx }) => {
    //...
  },
});

You can also define an onFailure function in your trigger.config.ts file to get notified when any task fails.

import type { TriggerConfig } from "@trigger.dev/sdk/v3";

export const config: TriggerConfig = {
  onFailure: async (payload, error, { ctx }) => {
    console.log("Task failed", ctx.task.id);
  },
};

​

handleError functions

You can define a function that will be called when an error is thrown in the run function, that allows you to control how the error is handled and whether the task should be retried.

Read more about handleError in our Errors and Retrying guide.

​

Next steps