Trigger.dev

Home

Integrations

Reference

Examples

v3 Developer Preview

Community

See every Task in every Run so you can tell exactly what happened.

Viewing Runs

Welcome to the Trigger.dev v3 documentation.

Introduction

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

Quick start

How to upgrade v2 jobs to v3 tasks, and how to use them together.

Upgrading from v2

Changelog

What features are currently available in the Developer Preview

Feature matrix

Your tasks live inside /trigger folders. Code in these is bundled and deployed together.

/trigger folders

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

Tasks

Tasks: Overview

Triggering

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

API keys

The simplest type of task which can be triggered from elsewhere in your code.

Regular tasks

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

Scheduled tasks

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

trigger.config file

The trigger.config.ts file

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

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

Environment Variables

The `trigger.dev deploy` command can be used to manually deploy.

CLI deploy command

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.

Overview

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

You can reattempt a task that has failed all of its attempts. You can also replay a task with a new version of your code.

Reattempting & Replaying

Send and receive notifications from your tasks to make your other systems aware of changes. For example, you can live-update your website as a task progresses.

Notifications

Retrieve run

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

Replay run

Cancel run

List Schedules

Create a new schedule based on the specified options.

Create Schedule

Retrieve Schedule

Update Schedule

Delete Schedule

Deactivate Schedule

Activate Schedule

GitHub repo

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

Self-hosting

You can contribute to Trigger.dev in many ways.

Contributing

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

Alerts

Uptime Status

GitHub Issues

GitHub Discussions

Discord Community

Slack support

Email us

Welcome to the Trigger.dev (v2) documentation.

v2: Introduction

Quick Starts: Introduction

Integrate Supabase with Trigger.dev in minutes.

Supabase

Supabase Quick Start

Best practices for writing well-behaving Jobs in your codebase

Writing Jobs - Step by Step

These are the built-in tasks that are available to use in your Jobs.

Task Library

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

Video walkthrough

What is Trigger.dev?

Limits

Projects are a group of [Jobs](/documentation/concepts/jobs) with [Environments](/documentation/concepts/environments-endpoints)

Projects

The Client is how you interact with the API, through an Adaptor.

Client & Adaptors

Jobs

When a [Job](/documentation/concepts/jobs) is [Triggered](/documentation/concepts/triggers), the Run function is called.

Runs

Tasks are individual building blocks of a Run.

Triggers: Introduction

Invoke Jobs manually using the invoke Trigger

Manual Invoke

Invoke triggers

Event triggers allow you to run Jobs from your own code (or your other Jobs)

Events

Event triggers

Scheduled

Scheduled triggers

HTTP Triggers allow you to trigger your Jobs from any webhooks.

HTTP

HTTP Trigger

Webhooks allow you to subscribe to events from APIs you use.

Webhooks

These are advanced features that allows you to attach dynamic triggers to a Job.

Dynamic

DynamicTrigger & DynamicSchedule

HTTP endpoints allow you to trigger your Jobs from any webhooks.

HTTP endpoints

Runs are resumable by returning Task stored data

Resumability

Delays can be used to wait for a certain amount of time before continuing a Run.

Delays

Integrations make it easy to use APIs in your Jobs

Authenticate your users with an Integration using Trigger.dev Connect.

Trigger.dev Connect

Environments and Endpoints are used to connect your server to the Trigger.dev platform.

Environments & Endpoints

How to get setup and deploy Jobs for your Next.js project

Next.js

How to get setup and deploy Jobs for your Express project

Express

How to get setup and deploy Jobs for your Remix project

Remix

How to get setup and deploy Jobs for your Redwood project

Redwood

How to get setup and deploy Jobs for your Astro project

Astro

How to get setup and deploy Jobs for your Nuxt project

Nuxt

How to get setup and deploy Jobs for your SvelteKit project

SvelteKit

How to get setup and deploy Jobs for your Fastify project

Fastify

Using the CLI

How to manually setup Trigger.dev in your Next.js project

How to manually setup Trigger.dev in your NestJS project

NestJS

How to manually setup Trigger.dev in your Express project

How to manually setup Trigger.dev in your Remix project

How to manually setup Trigger.dev in your Redwood project

How to manually setup Trigger.dev in your Astro project

How to manually setup Trigger.dev in your Nuxt project

How to manually setup Trigger.dev in your SvelteKit project

How to manually setup Trigger.dev in your Fastify project

Running your Jobs

Managing Jobs in your codebase and the dashboard

Managing Jobs

How to view, add, modify, and delete jobs

Testing Jobs

Rerunning

Integrations: Overview

Lots of APIs use API Keys or Personal Access Tokens to authenticate. This guide will show you how to use them.

API Keys and PATs

API Keys and Personal Access Tokens

Use OAuth to authenticate your team or to add Integrations to your product so your users can connect their accounts.

OAuth

Use Auth Resolvers to provide custom authentication credentials

Bring Your Own Auth

How to show the live status of Job Runs in your React app

React hooks: Overview

These allow you to show Run and Task progress without adding extra code to your Jobs.

Automatic React hooks

How to add `statuses` to your Job code and then subscribe using the hooks

Explicit status hooks

Deployment: Introduction

The first time you deploy to a new environment you will need to setup the endpoint for that environment.

First-time setup

You can manually refresh Endpoints in your Trigger.dev dashboard

Getting Started

Concepts

Guides

Community & Support

Overview

Viewing Runs

The Runs list

Run page

Getting Started

Concepts

Guides

Community & Support

Overview

​The Runs list

​Run page

The Runs list

Run page