/* 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;
}

Contact us if you have any questions, or would like help with any issues.

Get help

Get in touch with us!

Trigger.dev

Welcome to the Trigger.dev (v2) documentation.

Introduction

v2: Introduction

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

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

Integrations

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

Using the CLI

Running your Jobs

Managing Jobs in your codebase and the dashboard

Managing Jobs

They are declarative pattern-matching rules, modeled after [AWS EventBridge patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html).

Event Filters

TypeScript-first schema validation with static type inference

Zod Guide

You can contribute Integrations and core code to the Trigger.dev platform 

Contributing

This section is aimed at collecting common questions from users to provide documented answers.

Changelog

Roadmap

Integrations make it easy to authenticate and use APIs.

Integrations: Introduction

Streamline your project and issue tracking

Linear

Run machine learning tasks easily at scale

Replicate

Stripe

Typeform

The SDK is how you interact with Trigger.dev

SDK: Introduction

Job is used to create and configure a Job

The third parameter in a Job's `run()` function. An object that contains information about the Organization, Job, Run and more.

context

Context

The payload of a Run's completion webhook

RunNotification

Use `invokeTrigger()` to allow a Job to be manually triggered using `Job.invoke()`

invokeTrigger()

`eventTrigger()` is set as a [Job's trigger](/sdk/job) to subscribe to an event a Job from [a sent event](/sdk/triggerclient/instancemethods/sendevent).

eventTrigger()

`cronTrigger()` is set as a [Job's trigger](/docs/sdk/job) to trigger a Job on a recurring schedule using a CRON expression.

cronTrigger()

`intervalTrigger()` is set as a [Job's trigger](/sdk/job) to trigger a Job at a recurring interval.

intervalTrigger()

`HttpEndpoint` allows you to create and HttpTrigger, which means you can trigger your Jobs from any webhooks

HttpEndpoint

`HttpTrigger` allows you to trigger your Jobs from any webhooks.

HttpTrigger

An object containing the auth data for an integration that's using hosted auth.

ConnectionAuth

Use this function if you're using a `try/catch` block to catch errors.

isTriggerError()

An easy way to redact sensitive information from a string

redactString

Verify webhook payloads when they're using common signing methods.

verifyRequestSignature()

Send an event to Trigger.dev to trigger job runs through eventTrigger()

Create an event

The React SDK allows you to display the status of your Jobs and Runs in your React app.

React SDK: Introduction

The `TriggerProvider` component allows any hooks lower in the React hierarchy to connect to the Trigger.dev API.

TriggerProvider

The `useEventDetails()` React hook will show the live status of an event that was sent using `sendEvent()`.

useEventDetails()

The `useEventRunDetails()` React hook will show the live status of the first run triggered by `sendEvent()`.

useEventRunDetails()

The `useRunDetails()` React hook will show the live status of run.

useRunDetails()

Jobs and code examples you can use to get started.

Example Jobs

v3 documentation

Switch to v3 docs

Community

Quick Starts: Introduction

Integrate Supabase with Trigger.dev in minutes.

Supabase

Supabase Quick Start

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.

Tasks

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

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

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

How to view, add, modify, and delete jobs

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

Viewing Runs

Testing Jobs

Rerunning

Overview

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

Manual endpoint refreshing

Use our webhook to automatically tell us when you deploy

Automatic endpoint refreshing

You can self-host the Trigger.dev platform

Self hosting

Deploy self hosted version of [Trigger.dev](https://trigger.dev) to Fly.io

Deploy to Fly.io

Deploy self hosted version of [Trigger.dev](https://trigger.dev) to [Render](https://render.com/)

Deploy to Render

Deploy [Trigger.dev](https://trigger.dev) to your kubernetes cluster using our helm chart

Deploy to Kubernetes

Self-host [Trigger.dev](https://trigger.dev) with Supabase and Docker

Deploy with Supabase

Running the Trigger.dev platform locally requires tunneling to the internet.

Local platform

Create an Integration: Introduction

How to create the folders and basic files for an integration package.

Setup the package

What files are in an Integration package and what do they do?

The structure of an integration

OAuth is used to authenticate users by passing them to a third-party service, such as Google or Facebook, to log in.

Each integration has a client that performs the actual HTTP requests. Usually this is a wrapper around an official SDK provided by the service.

Creating the client

Tasks are the main way that developers will interact with your Integration. They are the actions that developers will be able to perform in their jobs.

Triggers cause a Job Run to start. Webhooks and polling are the most relevant for integrations.

Triggers

To test your integration you should create some example Jobs where you test all the functionality.

Getting Started

Concepts

Guides

Community & Support

Overview

Integrations

SDK

HTTP Reference

React SDK

Overview

Get in touch with us!

Join the community

Schedule a call