# Trigger.dev

## Docs

- [API keys](https://trigger-docs-build-extensions.mintlify.app/apikeys.md): How to authenticate with Trigger.dev so you can trigger tasks.
- [Changelog](https://trigger-docs-build-extensions.mintlify.app/changelog.md)
- [CLI deploy command](https://trigger-docs-build-extensions.mintlify.app/cli-deploy.md): The `trigger.dev deploy` command can be used to manually deploy.
- [CLI deploy options](https://trigger-docs-build-extensions.mintlify.app/cli-deploy-commands.md): Use these options to help deploy your tasks to Trigger.dev.
- [CLI dev command](https://trigger-docs-build-extensions.mintlify.app/cli-dev.md): The `trigger.dev dev` command is used to run your tasks locally.
- [CLI dev command](https://trigger-docs-build-extensions.mintlify.app/cli-dev-commands.md): The `trigger.dev dev` command is used to run your tasks locally.
- [CLI init command](https://trigger-docs-build-extensions.mintlify.app/cli-init-commands.md): Use these options when running the CLI `init` command.
- [Introduction](https://trigger-docs-build-extensions.mintlify.app/cli-introduction.md): The Trigger.dev CLI has a number of options and commands to help you develop locally, self host, and deploy your tasks.
- [CLI list-profiles command](https://trigger-docs-build-extensions.mintlify.app/cli-list-profiles-commands.md): Use these options when using the `list-profiles` CLI command.
- [CLI login command](https://trigger-docs-build-extensions.mintlify.app/cli-login-commands.md): Use these options when logging in to Trigger.dev using the CLI.
- [CLI logout command](https://trigger-docs-build-extensions.mintlify.app/cli-logout-commands.md): Use these options when using the `logout` CLI command.
- [CLI update command](https://trigger-docs-build-extensions.mintlify.app/cli-update-commands.md): Use these options when using the `update` CLI command.
- [CLI whoami command](https://trigger-docs-build-extensions.mintlify.app/cli-whoami-commands.md): Use these options to display the current logged in user and project details.
- [Discord Community](https://trigger-docs-build-extensions.mintlify.app/community.md)
- [The trigger.config.ts file](https://trigger-docs-build-extensions.mintlify.app/config/config-file.md): This file is used to configure your project and how it's built.
- [Build extensions](https://trigger-docs-build-extensions.mintlify.app/config/extensions/overview.md): Customize how your project is built and deployed to Trigger.dev with build extensions
- [Environment Variables](https://trigger-docs-build-extensions.mintlify.app/deploy-environment-variables.md): Any environment variables used in your tasks need to be added so the deployed code will run successfully.
- [Errors & Retrying](https://trigger-docs-build-extensions.mintlify.app/errors-retrying.md): How to deal with errors and write reliable tasks.
- [Generate an image using DALL·E 3](https://trigger-docs-build-extensions.mintlify.app/examples/dall-e3-generate-image.md): This example will show you how to generate an image using DALL·E 3 and text using GPT-4o with Trigger.dev.
- [Video processing with FFmpeg](https://trigger-docs-build-extensions.mintlify.app/examples/ffmpeg-video-processing.md): These examples show you how to process videos in various ways using FFmpeg with Trigger.dev.
- [Introduction](https://trigger-docs-build-extensions.mintlify.app/examples/intro.md): Learn how to use Trigger.dev with these practical task examples.
- [Call OpenAI with retrying](https://trigger-docs-build-extensions.mintlify.app/examples/open-ai-with-retrying.md): This example will show you how to call OpenAI with retrying using Trigger.dev.
- [Turn a PDF into an image using MuPDF](https://trigger-docs-build-extensions.mintlify.app/examples/pdf-to-image.md): This example will show you how to turn a PDF into an image using MuPDF and Trigger.dev.
- [Generate a PDF using react-pdf and save it to R2](https://trigger-docs-build-extensions.mintlify.app/examples/react-pdf.md): This example will show you how to generate a PDF using Trigger.dev.
- [Send a sequence of emails using Resend](https://trigger-docs-build-extensions.mintlify.app/examples/resend-email-sequence.md): This example will show you how to send a sequence of emails over several days using Resend with Trigger.dev.
- [Process images using Sharp](https://trigger-docs-build-extensions.mintlify.app/examples/sharp-image-processing.md): This example demonstrates how to process images using the Sharp library with Trigger.dev.
- [Using the Vercel AI SDK](https://trigger-docs-build-extensions.mintlify.app/examples/vercel-ai-sdk.md): This example demonstrates how to use the Vercel AI SDK with Trigger.dev.
- [GitHub Actions](https://trigger-docs-build-extensions.mintlify.app/github-actions.md): You can easily deploy your tasks with GitHub actions.
- [GitHub repo](https://trigger-docs-build-extensions.mintlify.app/github-repo.md)
- [Creating a project](https://trigger-docs-build-extensions.mintlify.app/guides/dashboard/creating-a-project.md): This guide will show you how to create a new Trigger.dev project.
- [Bun guide](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/bun.md): This guide will show you how to setup Trigger.dev with Bun
- [Introduction](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/introduction.md): Get started with Trigger.dev in your favorite framework.
- [Next.js setup guide](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/nextjs.md): This guide will show you how to setup Trigger.dev in your existing Next.js project, test an example task, and view the run.
- [Node.js setup guide](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/nodejs.md): This guide will show you how to setup Trigger.dev in your existing Node.js project, test an example task, and view the run.
- [Remix setup guide](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/remix.md): This guide will show you how to setup Trigger.dev in your existing Remix project, test an example task, and view the run.
- [Triggering tasks from Supabase edge functions](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/supabase-edge-functions-basic.md): This guide will show you how to trigger a task from a Supabase edge function, and then view the run in our dashboard.
- [Triggering tasks from Supabase database webhooks](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/supabase-edge-functions-database-webhooks.md): This guide will show you how to trigger a task when a row is added to a table using Supabase database webhooks.
- [Supabase guides](https://trigger-docs-build-extensions.mintlify.app/guides/frameworks/supabase-guides-overview.md): Guides for using Supabase with Trigger.dev.
- [Upgrading from v2](https://trigger-docs-build-extensions.mintlify.app/guides/use-cases/upgrading-from-v2.md): How to upgrade v2 jobs to v3 tasks, and how to use them together.
- [Email us](https://trigger-docs-build-extensions.mintlify.app/help-email.md)
- [Slack support](https://trigger-docs-build-extensions.mintlify.app/help-slack.md)
- [How it works](https://trigger-docs-build-extensions.mintlify.app/how-it-works.md): Understand how Trigger.dev works and how it can help you.
- [Idempotency](https://trigger-docs-build-extensions.mintlify.app/idempotency.md): An API call or operation is “idempotent” if it has the same result when called more than once.
- [Introduction](https://trigger-docs-build-extensions.mintlify.app/introduction.md): Welcome to the Trigger.dev v3 documentation.
- [Limits](https://trigger-docs-build-extensions.mintlify.app/limits.md): There are some hard and soft limits in v3 that you might hit.
- [Logging and tracing](https://trigger-docs-build-extensions.mintlify.app/logging.md): How to use the built-in logging and tracing system.
- [Machines](https://trigger-docs-build-extensions.mintlify.app/machines.md): Configure the number of vCPUs and GBs of RAM you want the task to use.
- [Create Env Var](https://trigger-docs-build-extensions.mintlify.app/management/envvars/create.md): Create a new environment variable for a specific project and environment.
- [Delete Env Var](https://trigger-docs-build-extensions.mintlify.app/management/envvars/delete.md): Delete a specific environment variable for a specific project and environment.
- [Import Env Vars](https://trigger-docs-build-extensions.mintlify.app/management/envvars/import.md): Upload mulitple environment variables for a specific project and environment.
- [List Env Vars](https://trigger-docs-build-extensions.mintlify.app/management/envvars/list.md): List all environment variables for a specific project and environment.
- [Retrieve Env Var](https://trigger-docs-build-extensions.mintlify.app/management/envvars/retrieve.md): Retrieve a specific environment variable for a specific project and environment.
- [Update Env Var](https://trigger-docs-build-extensions.mintlify.app/management/envvars/update.md): Update a specific environment variable for a specific project and environment.
- [Overview & Authentication](https://trigger-docs-build-extensions.mintlify.app/management/overview.md): Using the Trigger.dev v3 management API
- [List runs](https://trigger-docs-build-extensions.mintlify.app/management/projects/runs.md): 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.
- [Cancel run](https://trigger-docs-build-extensions.mintlify.app/management/runs/cancel.md): Cancels an in-progress run. If the run is already completed, this will have no effect.
- [List runs](https://trigger-docs-build-extensions.mintlify.app/management/runs/list.md): List runs in a specific environment. You can filter the runs by status, created at, task identifier, version, and more.
- [Replay run](https://trigger-docs-build-extensions.mintlify.app/management/runs/replay.md): Creates a new run with the same payload and options as the original run.
- [Reschedule run](https://trigger-docs-build-extensions.mintlify.app/management/runs/reschedule.md): Updates a delayed run with a new delay. Only valid when the run is in the DELAYED state.
- [Retrieve run](https://trigger-docs-build-extensions.mintlify.app/management/runs/retrieve.md): 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.
- [Activate Schedule](https://trigger-docs-build-extensions.mintlify.app/management/schedules/activate.md): 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()`.
- [Create Schedule](https://trigger-docs-build-extensions.mintlify.app/management/schedules/create.md): Create a new `IMPERATIVE` schedule based on the specified options.
- [Deactivate Schedule](https://trigger-docs-build-extensions.mintlify.app/management/schedules/deactivate.md): 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()`.
- [Delete Schedule](https://trigger-docs-build-extensions.mintlify.app/management/schedules/delete.md): 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()`.
- [List Schedules](https://trigger-docs-build-extensions.mintlify.app/management/schedules/list.md): List all schedules. You can also paginate the results.
- [Retrieve Schedule](https://trigger-docs-build-extensions.mintlify.app/management/schedules/retrieve.md): Get a schedule by its ID.
- [Get timezones](https://trigger-docs-build-extensions.mintlify.app/management/schedules/timezones.md): Get all supported timezones that schedule tasks support.
- [Update Schedule](https://trigger-docs-build-extensions.mintlify.app/management/schedules/update.md): 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()`.
- [Batch trigger](https://trigger-docs-build-extensions.mintlify.app/management/tasks/batch-trigger.md): Batch trigger a task with up to 100 payloads.
- [Trigger](https://trigger-docs-build-extensions.mintlify.app/management/tasks/trigger.md): Trigger a task by its identifier.
- [Notifications](https://trigger-docs-build-extensions.mintlify.app/notifications.md): 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.
- [Contributing](https://trigger-docs-build-extensions.mintlify.app/open-source-contributing.md): You can contribute to Trigger.dev in many ways.
- [Self-hosting](https://trigger-docs-build-extensions.mintlify.app/open-source-self-hosting.md): You can self-host Trigger.dev on your own infrastructure.
- [Concurrency & Queues](https://trigger-docs-build-extensions.mintlify.app/queue-concurrency.md): Configure what you want to happen when there is more than one run at a time.
- [Quick start](https://trigger-docs-build-extensions.mintlify.app/quick-start.md): How to get started in 3 minutes using the CLI and SDK.
- [Replaying](https://trigger-docs-build-extensions.mintlify.app/replaying.md): 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.
- [Request a feature](https://trigger-docs-build-extensions.mintlify.app/request-feature.md)
- [Roadmap](https://trigger-docs-build-extensions.mintlify.app/roadmap.md)
- [Run tests](https://trigger-docs-build-extensions.mintlify.app/run-tests.md): You can use the dashboard to run a test of your tasks.
- [Usage](https://trigger-docs-build-extensions.mintlify.app/run-usage.md): Get compute duration and cost from inside a run, or for a specific block of code.
- [Tags](https://trigger-docs-build-extensions.mintlify.app/tags.md): Tags allow you to easily filter runs in the dashboard and when using the SDK.
- [Tasks: Overview](https://trigger-docs-build-extensions.mintlify.app/tasks/overview.md): Tasks are functions that can run for a long time and provide strong resilience to failure.
- [Scheduled tasks (cron)](https://trigger-docs-build-extensions.mintlify.app/tasks/scheduled.md): A task that is triggered on a recurring schedule using cron syntax.
- [Triggering](https://trigger-docs-build-extensions.mintlify.app/triggering.md): Tasks need to be triggered in order to run.
- [Common problems](https://trigger-docs-build-extensions.mintlify.app/troubleshooting.md): Some common problems you might experience and their solutions
- [Alerts](https://trigger-docs-build-extensions.mintlify.app/troubleshooting-alerts.md): Get alerted when runs or deployments fail, or when deployments succeed.
- [GitHub Issues](https://trigger-docs-build-extensions.mintlify.app/troubleshooting-github-issues.md)
- [Uptime Status](https://trigger-docs-build-extensions.mintlify.app/troubleshooting-uptime-status.md)
- [Upgrade to new build system](https://trigger-docs-build-extensions.mintlify.app/upgrading-beta.md): How to update to 3.0.0 from the beta
- [How to upgrade the Trigger.dev packages](https://trigger-docs-build-extensions.mintlify.app/upgrading-packages.md): When we release fixes and new features we recommend you upgrade your Trigger.dev packages.
- [Vercel integration](https://trigger-docs-build-extensions.mintlify.app/vercel-integration.md): When you deploy to Vercel, automatically deploy your associated tasks.
- [Versioning](https://trigger-docs-build-extensions.mintlify.app/versioning.md): We use atomic versioning to ensure that started tasks are not affected by changes to the task code.
- [Wait: Overview](https://trigger-docs-build-extensions.mintlify.app/wait.md): During your run you can wait for a period of time or for something to happen.
- [Wait for](https://trigger-docs-build-extensions.mintlify.app/wait-for.md): Wait for a period of time, then continue execution.
- [Wait for event](https://trigger-docs-build-extensions.mintlify.app/wait-for-event.md): Wait until an event has been received, then continue execution.
- [Wait for request](https://trigger-docs-build-extensions.mintlify.app/wait-for-request.md): Wait until a `Request` has been received at the provided URL, then continue execution.
- [Wait until](https://trigger-docs-build-extensions.mintlify.app/wait-until.md): Wait until a date, then continue execution.
- [Writing tasks: Introduction](https://trigger-docs-build-extensions.mintlify.app/writing-tasks-introduction.md): Tasks are the core of Trigger.dev. They are long-running processes that are triggered by events.

## OpenAPI Specs

- [v3-openapi](https://trigger-docs-build-extensions.mintlify.app/v3-openapi.yaml)
- [openapi](https://trigger-docs-build-extensions.mintlify.app/openapi.yml)