Changelog

Trigger

Trigger.dev

Integrations

Reference

Example Jobs

Community

Welcome to the Trigger.dev documentation.

Introduction

Integrate Supabase with Trigger.dev in minutes.

Supabase

Supabase Quick Start

Create a Job

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

Video walkthrough

What is Trigger.dev?

Limitations

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

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.

Tasks

A Trigger is what starts a Job Run. It can be a webhook, a schedule, or an event.

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

Webhooks

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

Events

Event triggers

Scheduled

Scheduled triggers

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

Dynamic

DynamicTrigger & DynamicSchedule

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 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

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

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

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

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 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

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

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

Contributing

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

Get help

Get in touch with us!

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

Roadmap

Integrations make it easy to authenticate and use APIs.

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.

Testing

Publishing an official integration package to the public registry.

Publishing

Airtable

Streamline your project and issue tracking

Linear

OpenAI

Plain is customer support for developer tools

Plain

Run machine learning tasks easily at scale

Replicate

Resend

SendGrid

Slack

Stripe

Manage your Supabase organization, projects, and databases

Management API

Supabase Management API

Interact with your Supabase project using the Supabase JS Client.

JS Client

Supabase Client

Typeform

The SDK is how you interact with Trigger.dev

TriggerClient is used to create a client that connects to the Trigger.dev platform

The `TriggerClient()` constructor creates a new [TriggerClient](/sdk/triggerclient) object.

Constructor

TriggerClient: constructor

Job is used to create and configure a Job

The second parameter in a Job's `run()` function. It holds Integrations and useful actions you can perform.

Used to send log messages to the [Run log](/documentation/guides/viewing-runs).

logger

`io.wait()` waits for the specified amount of time before continuing the Job. Delays work even if you're on a serverless platform with timeouts, or if your server goes down. They utilize [resumability](/documentation/concepts/resumability) to ensure that the Run can be resumed after the delay.

wait()

io.wait()

`io.sendEvent()` allows you to send an event from inside a Job run. The sent even will trigger any Jobs that are listening for that event (based on the name).

sendEvent()

io.sendEvent()

`io.runTask()` allows you to run a [Task](/documentation/concepts/tasks) from inside a Job run.

runTask()

io.runTask()

`io.try()` allows you to run Tasks and catch any errors that are thrown, it's similar to a normal `try/catch` block but works with [io.runTask()](/sdk/io/runtask).

try()

io.try()

`io.backgroundFetch()` allows you to fetch data from a URL that can take longer that the serverless timeout. The actual `fetch` request is performed on the Trigger.dev platform, and the response is sent back to you. An example use case is fetching data from a slow API, like some AI endpoints.

backgroundFetch()

io.backgroundFetch()

`io.registerInterval()` allows you to register a [DynamicSchedule](/sdk/dynamicschedule) that will trigger any jobs it's attached to on a regular interval.

registerInterval()

io.registerInterval()

`io.unregisterInterval()` allows you to unregister a [DynamicSchedule](/sdk/dynamicschedule) that was previously registered with `io.registerInterval()`.

unregisterInterval()

io.unregisterInterval()

`io.registerCron()` allows you to register a [DynamicSchedule](/sdk/dynamicschedule) that will trigger any jobs it's attached to on a regular CRON schedule.

registerCron()

io.registerCron()

`io.unregisterCron()` allows you to unregister a [DynamicSchedule](/sdk/dynamicschedule) that was previously registered with `io.registerCron()`.

unregisterCron()

io.unregisterCron()

`io.registerTrigger()` allows you to register a [DynamicTrigger](/sdk/dynamictrigger) with the specified trigger data.

registerTrigger()

io.registerTrigger()

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

context

Context

`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.

Getting Started

Concepts

Guides

Community & Support

Changelog