/* Tooltip style on the code block */
div[class="absolute top-11 left-1/2 transform -translate-x-1/2 -translate-y-1/2 hidden group-hover:block text-white rounded-lg px-1.5 py-0.5 text-xs bg-primary-dark"] {
  color:#1A1B1F;
  border-radius: 0.25rem;
}

/* Link anchor active state - icon container */
div[class="mr-4 rounded-md p-1"] {
  border-radius: 0.25rem;
  border: 1px solid #464748;
}

/* Link anchor default state - icon container */
div[class="mr-4 rounded-md p-1 zinc-box group-hover:brightness-100 group-hover:ring-0 ring-1 ring-gray-950/5 dark:ring-gray-700/40"] {
  border-radius: 0.25rem;
  border: 1px solid transparent;
}

Common options

Options

Guides & examples

Trigger.dev

Switch to v2 docs

Discord

Use these options when using the `list-profiles` CLI command.

list-profiles

CLI list-profiles command

Welcome to the Trigger.dev v3 documentation.

Introduction

How to get started in 3 minutes using the CLI and SDK.

Quick start

Go from zero to a working task in your Next.js app in 10 minutes.

Video walkthrough

Understand how Trigger.dev works and how it can help you.

How it works

Beta upgrade

Upgrade to new build system

There are some hard and soft limits that you might hit.

Limits

Tasks are functions that can run for a long time and provide strong resilience to failure.

Overview

Tasks: Overview

Define tasks with a runtime payload schema and validate the payload before running the task.

Schema task

schemaTask

A task that is triggered on a recurring schedule using cron syntax.

Scheduled tasks (cron)

Tasks need to be triggered in order to run.

Triggering

Understanding the lifecycle of task run execution in Trigger.dev

Runs

How to authenticate with Trigger.dev so you can trigger tasks.

API keys

This file is used to configure your project and how it's built.

trigger.config.ts

The trigger.config.ts file

Customize how your project is built and deployed to Trigger.dev with build extensions

Build extensions

The `trigger.dev dev` command is used to run your tasks locally.

CLI dev command

You can use the dashboard to run a test of your tasks.

Run tests

The `trigger.dev deploy` command can be used to deploy your tasks to our infrastructure.

CLI deploy command

Any environment variables used in your tasks need to be added so the deployed code will run successfully.

Environment Variables

You can easily deploy your tasks with GitHub actions.

GitHub Actions

When you deploy to Vercel, automatically deploy your associated tasks.

Vercel integration

Tasks are the core of Trigger.dev. They are long-running processes that are triggered by events.

Writing tasks: Introduction

How to use the built-in logging and tracing system.

Logging and tracing

How to deal with errors and write reliable tasks.

Errors & Retrying

During your run you can wait for a period of time or for something to happen.

Wait: Overview

Wait for a period of time, then continue execution.

Wait for

Wait until a date, then continue execution.

Wait until

Wait until an event has been received, then continue execution.

Wait for event

Wait until a `Request` has been received at the provided URL, then continue execution.

Wait for request

Configure what you want to happen when there is more than one run at a time.

Concurrency & Queues

We use atomic versioning to ensure that started tasks are not affected by changes to the task code.

Versioning

Configure the number of vCPUs and GBs of RAM you want the task to use.

Machines

An API call or operation is “idempotent” if it has the same result when called more than once.

Idempotency

A replay is a copy of a run with the same payload but against the latest version in that environment. This is useful if something went wrong and you want to try again with the latest version of your code.

Replaying

Set a maximum duration for a task to run.

Max duration

Tags allow you to easily filter runs in the dashboard and when using the SDK.

Metadata

Run metadata

Get compute duration and cost from inside a run, or for a specific block of code.

Usage

Context

Using the Trigger.dev SDK from your frontend application.

Overview & Auth

Overview & Authentication

Using the Trigger.dev v3 API from your React application.

Get live updates from the Trigger.dev API in your frontend application.

Realtime

Realtime hooks

Triggering tasks from your frontend application.

Trigger hooks

Realtime overview

Stream data in realtime from inside your tasks

Streams

Realtime streams

Subscribes to all changes to a run in a React component.

React hooks

Realtime React hooks

subscribeToRun

runs.subscribeToRun

Subscribes to all changes to runs with a specific tag.

subscribeToRunsWithTag

runs.subscribeToRunsWithTag

Subscribes to all changes for runs in a batch.

subscribeToBatch

runs.subscribeToBatch

Trigger

Batch trigger a task with up to 100 payloads.

Batch trigger

List runs in a specific environment. You can filter the runs by status, created at, task identifier, version, and more.

List runs

Retrieve information about a run, including its status, payload, output, and attempts. If you authenticate with a Public API key, we will omit the payload and output fields for security reasons.


Retrieve run

Creates a new run with the same payload and options as the original run.

Replay run

Cancels an in-progress run. If the run is already completed, this will have no effect.

Cancel run

Updates a delayed run with a new delay. Only valid when the run is in the DELAYED state.

Reschedule run

Update metadata

List all schedules. You can also paginate the results.

List Schedules

Create a new `IMPERATIVE` schedule based on the specified options.

Create Schedule

Retrieve Schedule

Update a schedule by its ID. This will only work on `IMPERATIVE` schedules that were created in the dashboard or using the imperative SDK functions like `schedules.create()`.

Update Schedule

Delete a schedule by its ID. This will only work on `IMPERATIVE` schedules that were created in the dashboard or using the imperative SDK functions like `schedules.create()`.

Delete Schedule

Deactivate a schedule by its ID. This will only work on `IMPERATIVE` schedules that were created in the dashboard or using the imperative SDK functions like `schedules.create()`.

Deactivate Schedule

Activate a schedule by its ID. This will only work on `IMPERATIVE` schedules that were created in the dashboard or using the imperative SDK functions like `schedules.create()`.

Activate Schedule

Get all supported timezones that schedule tasks support.

Get timezones

List all environment variables for a specific project and environment.

List Env Vars

Upload mulitple environment variables for a specific project and environment.

Import Env Vars

Create a new environment variable for a specific project and environment.

Create Env Var

Retrieve a specific environment variable for a specific project and environment.

Retrieve Env Var

Update a specific environment variable for a specific project and environment.

Update Env Var

Delete a specific environment variable for a specific project and environment.

Delete Env Var

List runs in a project, across multiple environments, using Personal Access Token auth. You can filter the runs by status, created at, task identifier, version, and more.

The Trigger.dev CLI has a number of options and commands to help you develop locally, self host, and deploy your tasks.

Use these options when logging in to Trigger.dev using the CLI.

login

CLI login command

Use these options when running the CLI `init` command.

init

CLI init command

Use these options to help deploy your tasks to Trigger.dev.

deploy

CLI deploy options

Use these options to display the current logged in user and project details.

whoami

CLI whoami command

Use these options when using the `logout` CLI command.

logout

CLI logout command

Use these options when using the `update` CLI command.

update

CLI update command

You can self-host Trigger.dev on your own infrastructure.

Self-hosting

You can contribute to Trigger.dev in many ways.

Contributing

GitHub repo

Changelog

Roadmap

Some common problems you might experience and their solutions

Common problems

When we release fixes and new features we recommend you upgrade your Trigger.dev packages.

Upgrading packages

How to upgrade the Trigger.dev packages

Get alerted when runs or deployments fail, or when deployments succeed.

Alerts

Uptime Status

GitHub Issues

Request a feature

Discord Community

Slack support

Email us

An ever growing list of guides and examples to help you get setup with Trigger.dev.

Frameworks, guides and examples overview

This guide will show you how to setup Trigger.dev with Bun

Bun guide

This guide will show you how to setup Trigger.dev in your existing Next.js project, test an example task, and view the run.

Getting Started

Fundamentals

Development

Deployment

Writing tasks

Frontend usage

Realtime API

API reference

CLI

Open source

Troubleshooting

Help

CLI list-profiles command

Options

Common options

Getting Started

Fundamentals

Development

Deployment

Writing tasks

Frontend usage

Realtime API

API reference

CLI

Open source

Troubleshooting

Help

​Options

​Common options

Options

Common options