This command will return information about you, the logged in user.

whoami

trigger.dev whoami

Trigger.dev

Welcome to the Trigger.dev documentation.

Introduction

Getting Started: 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

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.

Changelog

Roadmap

Jobs and code examples you can use to get started.

Example Jobs

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

Welcome to the Trigger.dev v3 documentation.

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

Quick start

Upgrading from v2

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

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

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

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

You can add filters to your tasks so they're only triggered when certain conditions are met.

Trigger filters

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

You can rollback changes when errors happen, to give transactional guarantees to your operations.

Rollbacks

You can use any Node.js library inside the run function, or do HTTP requests.

Using APIs

This function is called before the `run` function, it allows you to wrap the run function with custom code.

Middleware

Automated tests

The dashboard has many features including: managing your projects, viewing run logs, editing environment variables and more.

Overview

Dashboard: overview

Find runs and view the detailed traces and logs for each run.

Runs

Dashboard: runs

Test your tasks in Dev, Staging and Prod from the dashboard.

Tests

Dashboard: tests

Add, edit and delete Environment Variables from the Dashboard.

Dashboard: environment variables

This file is used to configure some settings for your project.

trigger.config file

The trigger.config.js file

An overview of how Trigger.dev v3 works under the hood.

How it works

Architecture: How it works

We built a reliable and fair multi-tenant queue that controls triggering all tasks.

Multi-tenant queue

Architecture: Multi-tenant queue

How reliability is achieved with Trigger.dev.

Reliability

Architecture: Reliability

GitHub repo

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

Self-hosting

You can contribute to Trigger.dev in many ways.

FAQs

Frequently Asked Questions

Community

Email us

Slack

Uptime status

Reference

Examples

v3 Developer Preview

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.

Getting Started

Fundamentals

Development

Deployment

Writing tasks

Dashboard

API reference

Architecture

Open source

Help

trigger.dev whoami