# Trigger.dev ## Docs - [Changelog](https://trigger-features-v3-docs.mintlify.site/documentation/changelog.md) - [Client & Adaptors](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/client-adaptors.md): The Client is how you interact with the API, through an Adaptor. - [Trigger.dev Connect](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/connect.md): Authenticate your users with an Integration using Trigger.dev Connect. - [Delays](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/delays.md): Delays can be used to wait for a certain amount of time before continuing a Run. - [Environments & Endpoints](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/environments-endpoints.md): Environments and Endpoints are used to connect your server to the Trigger.dev platform. - [HTTP endpoints](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/http-endpoints.md): HTTP endpoints allow you to trigger your Jobs from any webhooks. - [Integrations](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/integrations.md): Integrations make it easy to use APIs in your Jobs - [Jobs](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/jobs.md): When this happens, do this. - [Limits](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/limits.md) - [Projects](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/projects.md): Projects are a group of [Jobs](/documentation/concepts/jobs) with [Environments](/documentation/concepts/environments-endpoints) - [Resumability](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/resumability.md): Runs are resumable by returning Task stored data - [Runs](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/runs.md): When a [Job](/documentation/concepts/jobs) is [Triggered](/documentation/concepts/triggers), the Run function is called. - [Tasks](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/tasks.md): Tasks are individual building blocks of a Run. - [DynamicTrigger & DynamicSchedule](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/dynamic.md): These are advanced features that allows you to attach dynamic triggers to a Job. - [Event triggers](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/events.md): Event triggers allow you to run Jobs from your own code (or your other Jobs) - [HTTP Trigger](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/http.md): HTTP Triggers allow you to trigger your Jobs from any webhooks. - [Triggers: Introduction](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/introduction.md) - [Invoke triggers](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/invoke.md): Invoke Jobs manually using the invoke Trigger - [Scheduled triggers](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/scheduled.md): Run a Job on a recurring schedule - [Webhooks](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/triggers/webhooks.md): Webhooks allow you to subscribe to events from APIs you use. - [What is Trigger.dev?](https://trigger-features-v3-docs.mintlify.site/documentation/concepts/what-is-triggerdotdev.md) - [FAQ](https://trigger-features-v3-docs.mintlify.site/documentation/faq.md): This section is aimed at collecting common questions from users to provide documented answers. - [Get in touch with us!](https://trigger-features-v3-docs.mintlify.site/documentation/get-help.md): Contact us if you have any questions, or would like help with any issues. - [Using the CLI](https://trigger-features-v3-docs.mintlify.site/documentation/guides/cli.md): How to use the CLI - [Contributing](https://trigger-features-v3-docs.mintlify.site/documentation/guides/contributing.md): You can contribute Integrations and core code to the Trigger.dev platform - [Deployment: Introduction](https://trigger-features-v3-docs.mintlify.site/documentation/guides/deployment.md): A guide for how to deploy your Jobs - [Automatic endpoint refreshing](https://trigger-features-v3-docs.mintlify.site/documentation/guides/deployment-automatic.md): Use our webhook to automatically tell us when you deploy - [Manual endpoint refreshing](https://trigger-features-v3-docs.mintlify.site/documentation/guides/deployment-manual.md): You can manually refresh Endpoints in your Trigger.dev dashboard - [First-time setup](https://trigger-features-v3-docs.mintlify.site/documentation/guides/deployment-setup.md): The first time you deploy to a new environment you will need to setup the endpoint for that environment. - [Event Filters](https://trigger-features-v3-docs.mintlify.site/documentation/guides/event-filter.md): They are declarative pattern-matching rules, modeled after [AWS EventBridge patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html). - [Managing Jobs](https://trigger-features-v3-docs.mintlify.site/documentation/guides/jobs/managing.md): Managing Jobs in your codebase and the dashboard - [Managing Jobs](https://trigger-features-v3-docs.mintlify.site/documentation/guides/managing-jobs.md): How to view, add, modify, and delete jobs - [Astro](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/astro.md): How to manually setup Trigger.dev in your Astro project - [Express](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/express.md): How to manually setup Trigger.dev in your Express project - [Fastify](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/fastify.md): How to manually setup Trigger.dev in your Fastify project - [NestJS](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/nestjs.md): How to manually setup Trigger.dev in your NestJS project - [Next.js](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/nextjs.md): How to manually setup Trigger.dev in your Next.js project - [Nuxt](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/nuxt.md): How to manually setup Trigger.dev in your Nuxt project - [Redwood](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/redwood.md): How to manually setup Trigger.dev in your Redwood project - [Remix](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/remix.md): How to manually setup Trigger.dev in your Remix project - [SvelteKit](https://trigger-features-v3-docs.mintlify.site/documentation/guides/manual/sveltekit.md): How to manually setup Trigger.dev in your SvelteKit project - [Astro](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/astro.md): How to get setup and deploy Jobs for your Astro project - [Express](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/express.md): How to get setup and deploy Jobs for your Express project - [Fastify](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/fastify.md): How to get setup and deploy Jobs for your Fastify project - [Next.js](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/nextjs.md): How to get setup and deploy Jobs for your Next.js project - [Nuxt](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/nuxt.md): How to get setup and deploy Jobs for your Nuxt project - [Redwood](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/redwood.md): How to get setup and deploy Jobs for your Redwood project - [Remix](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/remix.md): How to get setup and deploy Jobs for your Remix project - [SvelteKit](https://trigger-features-v3-docs.mintlify.site/documentation/guides/platforms/sveltekit.md): How to get setup and deploy Jobs for your SvelteKit project - [React hooks: Overview](https://trigger-features-v3-docs.mintlify.site/documentation/guides/react-hooks.md): How to show the live status of Job Runs in your React app - [Automatic React hooks](https://trigger-features-v3-docs.mintlify.site/documentation/guides/react-hooks-automatic.md): These allow you to show Run and Task progress without adding extra code to your Jobs. - [Explicit status hooks](https://trigger-features-v3-docs.mintlify.site/documentation/guides/react-hooks-statuses.md): How to add `statuses` to your Job code and then subscribe using the hooks - [Rerunning](https://trigger-features-v3-docs.mintlify.site/documentation/guides/rerunning.md): From a Run page, you can rerun - [Running your Jobs](https://trigger-features-v3-docs.mintlify.site/documentation/guides/running-jobs.md): A guide for how to run your Jobs. - [Self hosting](https://trigger-features-v3-docs.mintlify.site/documentation/guides/self-hosting.md): You can self-host the Trigger.dev platform - [Deploy to Fly.io](https://trigger-features-v3-docs.mintlify.site/documentation/guides/self-hosting/flyio.md): Deploy self hosted version of [Trigger.dev](https://trigger.dev) to Fly.io - [Deploy to Kubernetes](https://trigger-features-v3-docs.mintlify.site/documentation/guides/self-hosting/kubernetes.md): Deploy [Trigger.dev](https://trigger.dev) to your kubernetes cluster using our helm chart - [Deploy to Render](https://trigger-features-v3-docs.mintlify.site/documentation/guides/self-hosting/render.md): Deploy self hosted version of [Trigger.dev](https://trigger.dev) to [Render](https://render.com/) - [Deploy with Supabase](https://trigger-features-v3-docs.mintlify.site/documentation/guides/self-hosting/supabase.md): Self-host [Trigger.dev](https://trigger.dev) with Supabase and Docker - [Task Library](https://trigger-features-v3-docs.mintlify.site/documentation/guides/task-library.md): These are the built-in tasks that are available to use in your Jobs. - [Testing Jobs](https://trigger-features-v3-docs.mintlify.site/documentation/guides/testing-jobs.md): You can test Jobs from the dashboard. - [Local platform](https://trigger-features-v3-docs.mintlify.site/documentation/guides/tunneling-platform.md): Running the Trigger.dev platform locally requires tunneling to the internet. - [Integrations: Overview](https://trigger-features-v3-docs.mintlify.site/documentation/guides/using-integrations.md): How to use Trigger.dev Integrations - [API Keys and Personal Access Tokens](https://trigger-features-v3-docs.mintlify.site/documentation/guides/using-integrations-apikeys.md): Lots of APIs use API Keys or Personal Access Tokens to authenticate. This guide will show you how to use them. - [Bring Your Own Auth](https://trigger-features-v3-docs.mintlify.site/documentation/guides/using-integrations-byo-auth.md): Use Auth Resolvers to provide custom authentication credentials - [OAuth](https://trigger-features-v3-docs.mintlify.site/documentation/guides/using-integrations-oauth.md): Use OAuth to authenticate your team or to add Integrations to your product so your users can connect their accounts. - [Video walkthrough](https://trigger-features-v3-docs.mintlify.site/documentation/guides/video-walkthrough.md): Go from zero to a working Job in your Next.js app in 10 minutes. - [Viewing Runs](https://trigger-features-v3-docs.mintlify.site/documentation/guides/viewing-runs.md): See every Task in every Run so you can tell exactly what happened. - [Writing Jobs - Step by Step](https://trigger-features-v3-docs.mintlify.site/documentation/guides/writing-jobs-step-by-step.md): Best practices for writing well-behaving Jobs in your codebase - [Zod Guide](https://trigger-features-v3-docs.mintlify.site/documentation/guides/zod.md): TypeScript-first schema validation with static type inference - [Getting Started: Introduction](https://trigger-features-v3-docs.mintlify.site/documentation/introduction.md): Welcome to the Trigger.dev documentation. - [Astro Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/astro.md): Start creating Jobs in 5 minutes in your Astro project. - [Express Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/express.md): Start creating Jobs in 5 minutes in your Express project. - [Fastify Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/fastify.md): Start creating Jobs in 5 minutes in your Fastify project. - [Hono Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/hono.md): Start creating Jobs in 5 minutes in your Hono project. - [Quick Starts: Introduction](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/introduction.md) - [NestJS Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/nestjs.md): Start creating Jobs in 5 minutes in your NestJS project. - [Next.js Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/nextjs.md): Start creating Jobs in 5 minutes in your Next.js project. - [Nuxt Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/nuxt.md): Start creating Jobs in 5 minutes in your Nuxt project. - [Redwood Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/redwood.md): Start creating Jobs in 5 minutes in your Redwood project. - [Remix Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/remix.md): Start creating Jobs in 5 minutes in your Remix project. - [Supabase Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/supabase.md): Integrate Supabase with Trigger.dev in minutes. - [SvelteKit Quick Start](https://trigger-features-v3-docs.mintlify.site/documentation/quickstarts/sveltekit.md): Start creating Jobs in 5 minutes in your SvelteKit project. - [Roadmap](https://trigger-features-v3-docs.mintlify.site/documentation/roadmap.md) - [Example Jobs](https://trigger-features-v3-docs.mintlify.site/examples/introduction.md): Jobs and code examples you can use to get started. - [Airtable overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/airtable.md) - [Airtable tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/airtable-tasks.md) - [GitHub overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/github.md) - [GitHub Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/github-tasks.md) - [GitHub Triggers & Events](https://trigger-features-v3-docs.mintlify.site/integrations/apis/github-triggers.md) - [Linear](https://trigger-features-v3-docs.mintlify.site/integrations/apis/linear.md): Streamline your project and issue tracking - [OpenAI overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai.md) - [Assistant Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/assistants.md) - [Chat Completion Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/chat.md) - [Completion Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/completions.md) - [File Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/files.md) - [Fine Tuning Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/fine-tunes.md) - [Image Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/images.md) - [Model Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/openai/models.md) - [Plain overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/plain.md) - [Plain tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/plain-tasks.md) - [Replicate](https://trigger-features-v3-docs.mintlify.site/integrations/apis/replicate.md): Run machine learning tasks easily at scale - [Resend overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/resend.md) - [Resend tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/resend-tasks.md) - [SendGrid overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/sendgrid.md) - [SendGrid tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/sendgrid-tasks.md) - [Shopify overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/shopify.md) - [Shopify Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/shopify-tasks.md) - [Shopify Triggers & Events](https://trigger-features-v3-docs.mintlify.site/integrations/apis/shopify-triggers.md) - [Slack overview & authentication](https://trigger-features-v3-docs.mintlify.site/integrations/apis/slack.md) - [Slack tasks](https://trigger-features-v3-docs.mintlify.site/integrations/apis/slack-tasks.md) - [Stripe](https://trigger-features-v3-docs.mintlify.site/integrations/apis/stripe.md) - [Supabase Client](https://trigger-features-v3-docs.mintlify.site/integrations/apis/supabase/client.md): Interact with your Supabase project using the Supabase JS Client. - [Supabase: Introduction](https://trigger-features-v3-docs.mintlify.site/integrations/apis/supabase/introduction.md) - [Supabase Management API](https://trigger-features-v3-docs.mintlify.site/integrations/apis/supabase/management.md): Manage your Supabase organization, projects, and databases - [Typeform](https://trigger-features-v3-docs.mintlify.site/integrations/apis/typeform.md) - [Create an Integration: Introduction](https://trigger-features-v3-docs.mintlify.site/integrations/create.md): You can create Integrations of your own. - [The structure of an integration](https://trigger-features-v3-docs.mintlify.site/integrations/create-anatomy.md): What files are in an Integration package and what do they do? - [Creating the client](https://trigger-features-v3-docs.mintlify.site/integrations/create-client.md): Each integration has a client that performs the actual HTTP requests. Usually this is a wrapper around an official SDK provided by the service. - [OAuth](https://trigger-features-v3-docs.mintlify.site/integrations/create-oauth.md): OAuth is used to authenticate users by passing them to a third-party service, such as Google or Facebook, to log in. - [Publishing](https://trigger-features-v3-docs.mintlify.site/integrations/create-publishing.md): Publishing an official integration package to the public registry. - [Setup the package](https://trigger-features-v3-docs.mintlify.site/integrations/create-setup.md): How to create the folders and basic files for an integration package. - [Tasks](https://trigger-features-v3-docs.mintlify.site/integrations/create-tasks.md): 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. - [Testing](https://trigger-features-v3-docs.mintlify.site/integrations/create-testing.md): To test your integration you should create some example Jobs where you test all the functionality. - [Triggers](https://trigger-features-v3-docs.mintlify.site/integrations/create-triggers.md): Triggers cause a Job Run to start. Webhooks and polling are the most relevant for integrations. - [Integrations: Introduction](https://trigger-features-v3-docs.mintlify.site/integrations/introduction.md): Integrations make it easy to authenticate and use APIs. - [Create an event](https://trigger-features-v3-docs.mintlify.site/sdk/api-reference/events/create-an-event.md): Send an event to Trigger.dev to trigger job runs through eventTrigger() - [ConnectionAuth](https://trigger-features-v3-docs.mintlify.site/sdk/connection-auth.md): An object containing the auth data for an integration that's using hosted auth. - [Context](https://trigger-features-v3-docs.mintlify.site/sdk/context.md): The third parameter in a Job's `run()` function. An object that contains information about the Organization, Job, Run and more. - [cronTrigger()](https://trigger-features-v3-docs.mintlify.site/sdk/crontrigger.md): `cronTrigger()` is set as a [Job's trigger](/docs/sdk/job) to trigger a Job on a recurring schedule using a CRON expression. - [DynamicSchedule: Constructor](https://trigger-features-v3-docs.mintlify.site/sdk/dynamicschedule/constructor.md): The `DynamicSchedule()` constructor creates a new [DynamicSchedule](/sdk/dynamicschedule/overview) instance. - [DynamicSchedule: Overview](https://trigger-features-v3-docs.mintlify.site/sdk/dynamicschedule/overview.md): `DynamicSchedule` allows you to define a scheduled trigger that can be configured dynamically at runtime. - [DynamicSchedule: register() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/dynamicschedule/register.md): Use this method to register a new schedule with the DynamicSchedule. - [DynamicSchedule: unregister() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/dynamicschedule/unregister.md): Use this method to unregister a schedule from a DynamicSchedule. - [DynamicTrigger: Constructor](https://trigger-features-v3-docs.mintlify.site/sdk/dynamictrigger/constructor.md): The `DynamicTrigger()` constructor creates a new [DynamicTrigger](/sdk/dynamictrigger/overview) instance. - [DynamicTrigger: Overview](https://trigger-features-v3-docs.mintlify.site/sdk/dynamictrigger/overview.md): `DynamicTrigger` allows you to define a trigger that can be configured dynamically at runtime. - [DynamicTrigger: register() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/dynamictrigger/register.md): Use this method to register a new configuration with the DynamicTrigger. - [DynamicTrigger: unregister() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/dynamictrigger/unregister.md): Use this method to unregister a schedule from a DynamicTrigger. - [eventTrigger()](https://trigger-features-v3-docs.mintlify.site/sdk/eventtrigger.md): `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). - [HttpEndpoint](https://trigger-features-v3-docs.mintlify.site/sdk/http-endpoint.md): `HttpEndpoint` allows you to create and HttpTrigger, which means you can trigger your Jobs from any webhooks - [HttpTrigger](https://trigger-features-v3-docs.mintlify.site/sdk/http-trigger.md): `HttpTrigger` allows you to trigger your Jobs from any webhooks. - [intervalTrigger()](https://trigger-features-v3-docs.mintlify.site/sdk/intervaltrigger.md): `intervalTrigger()` is set as a [Job's trigger](/sdk/job) to trigger a Job at a recurring interval. - [SDK: Introduction](https://trigger-features-v3-docs.mintlify.site/sdk/introduction.md): The SDK is how you interact with Trigger.dev - [invokeTrigger()](https://trigger-features-v3-docs.mintlify.site/sdk/invoke-trigger.md): Use `invokeTrigger()` to allow a Job to be manually triggered using `Job.invoke()` - [io.backgroundPoll()](https://trigger-features-v3-docs.mintlify.site/sdk/io/background-poll.md): `io.backgroundPoll()` allows you to fetch data from a URL on an interval. - [io.backgroundFetch()](https://trigger-features-v3-docs.mintlify.site/sdk/io/backgroundfetch.md): `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. - [logger](https://trigger-features-v3-docs.mintlify.site/sdk/io/logger.md): Used to send log messages to the [Run log](/docs/documentation/guides/viewing-runs). - [IO: Overview](https://trigger-features-v3-docs.mintlify.site/sdk/io/overview.md): The second parameter in a Job's `run()` function. It holds Integrations and useful actions you can perform. - [io.random()](https://trigger-features-v3-docs.mintlify.site/sdk/io/random.md): `io.random()` is identical to `Math.random()` when called without options but ensures your random numbers are not regenerated on resume or retry. It will return a pseudo-random floating-point number between optional `min` (default: 0, inclusive) and `max` (default: 1, exclusive). Can optionally `rou… - [io.registerCron()](https://trigger-features-v3-docs.mintlify.site/sdk/io/registercron.md): `io.registerCron()` allows you to register a [DynamicSchedule](/sdk/dynamicschedule) that will trigger any jobs it's attached to on a regular CRON schedule. - [io.registerInterval()](https://trigger-features-v3-docs.mintlify.site/sdk/io/registerinterval.md): `io.registerInterval()` allows you to register a [DynamicSchedule](/sdk/dynamicschedule) that will trigger any jobs it's attached to on a regular interval. - [io.registerTrigger()](https://trigger-features-v3-docs.mintlify.site/sdk/io/registertrigger.md): `io.registerTrigger()` allows you to register a [DynamicTrigger](/sdk/dynamictrigger) with the specified trigger data. - [io.runTask()](https://trigger-features-v3-docs.mintlify.site/sdk/io/runtask.md): Creates and runs a Task inside a Run. - [io.sendEvent()](https://trigger-features-v3-docs.mintlify.site/sdk/io/sendevent.md): `io.sendEvent()` allows you to send an event from inside a Job run. The sent event will trigger any Jobs that are listening for that event (based on the name). - [io.sendEvents()](https://trigger-features-v3-docs.mintlify.site/sdk/io/sendevents.md): `io.sendEvents()` allows you to send multiple events from inside a Job run. The sent events will trigger any Jobs that are listening for those events (based on the name). - [store](https://trigger-features-v3-docs.mintlify.site/sdk/io/store.md): Exposes namespaced **Key-Value Stores** you can access inside of your Jobs. - [io.try()](https://trigger-features-v3-docs.mintlify.site/sdk/io/try.md): `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). - [io.unregisterCron()](https://trigger-features-v3-docs.mintlify.site/sdk/io/unregistercron.md): `io.unregisterCron()` allows you to unregister a [DynamicSchedule](/sdk/dynamicschedule) that was previously registered with `io.registerCron()`. - [io.unregisterInterval()](https://trigger-features-v3-docs.mintlify.site/sdk/io/unregisterinterval.md): `io.unregisterInterval()` allows you to unregister a [DynamicSchedule](/sdk/dynamicschedule) that was previously registered with `io.registerInterval()`. - [io.wait()](https://trigger-features-v3-docs.mintlify.site/sdk/io/wait.md): `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. - [io.waitForEvent()](https://trigger-features-v3-docs.mintlify.site/sdk/io/wait-for-event.md): `io.waitForEvent()` waits for the next event to be emitted, and returns the event data - [io.waitForRequest()](https://trigger-features-v3-docs.mintlify.site/sdk/io/wait-for-request.md): `io.waitForRequest()` waits for a request to be made to the provided URL. - [isTriggerError()](https://trigger-features-v3-docs.mintlify.site/sdk/istriggererror.md): Use this function if you're using a `try/catch` block to catch errors. - [Job](https://trigger-features-v3-docs.mintlify.site/sdk/job.md): Job is used to create and configure a Job - [React SDK: Introduction](https://trigger-features-v3-docs.mintlify.site/sdk/react/introduction.md): The React SDK allows you to display the status of your Jobs and Runs in your React app. - [TriggerProvider](https://trigger-features-v3-docs.mintlify.site/sdk/react/triggerprovider.md): The `TriggerProvider` component allows any hooks lower in the React hierarchy to connect to the Trigger.dev API. - [useEventDetails()](https://trigger-features-v3-docs.mintlify.site/sdk/react/useeventdetails.md): The `useEventDetails()` React hook will show the live status of an event that was sent using `sendEvent()`. - [useEventRunDetails()](https://trigger-features-v3-docs.mintlify.site/sdk/react/useeventrundetails.md): The `useEventRunDetails()` React hook will show the live status of the first run triggered by `sendEvent()`. - [useRunDetails()](https://trigger-features-v3-docs.mintlify.site/sdk/react/userundetails.md): The `useRunDetails()` React hook will show the live status of run. - [redactString](https://trigger-features-v3-docs.mintlify.site/sdk/redactstring.md): An easy way to redact sensitive information from a string - [RunNotification](https://trigger-features-v3-docs.mintlify.site/sdk/run-notification.md): The payload of a Run's completion webhook - [TriggerClient: constructor](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/constructor.md): The `TriggerClient()` constructor creates a new [TriggerClient](/sdk/triggerclient) object. - [TriggerClient: cancelEvent() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/cancel-event.md): The `cancelEvent()` instance method will cancel an event that is scheduled to be delivered in the future. - [TriggerClient: cancelRunsForEvent() Instance Method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/cancel-runs-for-event.md): The `cancelRunsForEvent()` instance method will cancel all the job runs (yet to be executed) that are triggered by a given eventId. - [TriggerClient: cancelRunsForJob() Instance Method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/cancel-runs-for-job.md): The `cancelRunsForJob()` instance method will cancel all job runs (yet to be executed) with the given jobId. - [defineConcurrencyLimit()](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/concurrency-limit.md): Define a concurrency limit group to control the concurrency of your jobs. - [defineAuthResolver()](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/define-auth-resolver.md): Define a custom auth resolver for a specific integration - [defineDynamicSchedule()](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/define-dynamic-schedule.md): Define a Dynamic Schedule - [defineDynamicTrigger()](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/define-dynamic-trigger.md): Define a Dynamic Trigger - [defineHttpEndpoint()](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/define-http-endpoint.md): Defines an HTTP Endpoint - [defineJob()](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/define-job.md): Defines a job - [TriggerClient: getEvent() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/getevent.md): The `getEvent()` method gets the event details for a given eventId. - [TriggerClient: getRun() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/getrun.md): The `getRun()` method gets the details for a given Run. - [TriggerClient: getRuns() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/getruns.md): The `getRuns()` method gets runs for a Job. - [TriggerClient: on() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/on.md): Use the `on()` method to listen for run notifications across all Jobs. - [TriggerClient: sendEvent() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/sendevent.md): The `sendEvent()` instance method send an event that triggers any Jobs that are listening for that event (based on the name). - [TriggerClient: sendEvents() instance method](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/instancemethods/sendevents.md): The `sendEvents()` instance method send multiple events that triggers any Jobs that are listening for those events (based on the name). - [TriggerClient: Overview](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/overview.md): TriggerClient is used to create a client that connects to the Trigger.dev platform - [store](https://trigger-features-v3-docs.mintlify.site/sdk/triggerclient/store.md): Exposes namespaced **Key-Value Stores** you can access in and outside of your Jobs. - [verifyRequestSignature()](https://trigger-features-v3-docs.mintlify.site/sdk/verify-request-signature.md): Verify webhook payloads when they're using common signing methods. - [Architecture: How it works](https://trigger-features-v3-docs.mintlify.site/v3/architecture-how-it-works.md): An overview of how Trigger.dev v3 works under the hood. - [Architecture: Multi-tenant queue](https://trigger-features-v3-docs.mintlify.site/v3/architecture-multi-tenant-queue.md): We built a reliable and fair multi-tenant queue that controls triggering all tasks. - [Architecture: Reliability](https://trigger-features-v3-docs.mintlify.site/v3/architecture-reliability.md): How reliability is achieved with Trigger.dev. - [Automated tests](https://trigger-features-v3-docs.mintlify.site/v3/automated-tests.md): Write automated tests of your tasks. - [Changelog](https://trigger-features-v3-docs.mintlify.site/v3/changelog.md) - [CLI deploy command](https://trigger-features-v3-docs.mintlify.site/v3/cli-deploy.md): The `trigger.dev deploy` command can be used to manually deploy. - [CLI dev command](https://trigger-features-v3-docs.mintlify.site/v3/cli-dev.md): The `trigger.dev dev` command is used to run your tasks locally. - [Community](https://trigger-features-v3-docs.mintlify.site/v3/community.md) - [Dashboard: environment variables](https://trigger-features-v3-docs.mintlify.site/v3/dashboard-environment-variables.md): Add, edit and delete Environment Variables from the Dashboard. - [Dashboard: overview](https://trigger-features-v3-docs.mintlify.site/v3/dashboard-overview.md): The dashboard has many features including: managing your projects, viewing run logs, editing environment variables and more. - [Dashboard: runs](https://trigger-features-v3-docs.mintlify.site/v3/dashboard-runs.md): Find runs and view the detailed traces and logs for each run. - [Dashboard: tests](https://trigger-features-v3-docs.mintlify.site/v3/dashboard-tests.md): Test your tasks in Dev, Staging and Prod from the dashboard. - [Environment Variables](https://trigger-features-v3-docs.mintlify.site/v3/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-features-v3-docs.mintlify.site/v3/errors-retrying.md): How to deal with errors and write reliable tasks. - [Feature matrix](https://trigger-features-v3-docs.mintlify.site/v3/feature-matrix.md): What features are currently available in the Developer Preview - [GitHub Actions](https://trigger-features-v3-docs.mintlify.site/v3/github-actions.md): You can easily deploy your tasks with GitHub actions. - [GitHub repo](https://trigger-features-v3-docs.mintlify.site/v3/github-repo.md) - [Email us](https://trigger-features-v3-docs.mintlify.site/v3/help-email.md) - [Frequently Asked Questions](https://trigger-features-v3-docs.mintlify.site/v3/help-faqs.md) - [Slack](https://trigger-features-v3-docs.mintlify.site/v3/help-slack.md) - [Uptime status](https://trigger-features-v3-docs.mintlify.site/v3/help-uptime-status.md) - [Idempotency](https://trigger-features-v3-docs.mintlify.site/v3/idempotency.md): An API call or operation is “idempotent” if it has the same result when called more than once. - [Introduction](https://trigger-features-v3-docs.mintlify.site/v3/introduction.md): Welcome to the Trigger.dev v3 documentation. - [Limits](https://trigger-features-v3-docs.mintlify.site/v3/limits.md) - [Logging and tracing](https://trigger-features-v3-docs.mintlify.site/v3/logging.md): How to use the built-in logging and tracing system. - [Machines](https://trigger-features-v3-docs.mintlify.site/v3/machines.md): Configure the number of vCPUs and GBs of RAM you want the task to use. - [Middleware](https://trigger-features-v3-docs.mintlify.site/v3/middleware.md): This function is called before the `run` function, it allows you to wrap the run function with custom code. - [Notifications](https://trigger-features-v3-docs.mintlify.site/v3/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-features-v3-docs.mintlify.site/v3/open-source-contributing.md): You can contribute to Trigger.dev in many ways. - [Self-hosting](https://trigger-features-v3-docs.mintlify.site/v3/open-source-self-hosting.md): You can self-host Trigger.dev on your own infrastructure. - [Concurrency & Queues](https://trigger-features-v3-docs.mintlify.site/v3/queue-concurrency.md): Configure what you want to happen when there is more than one run at a time. - [Quick start](https://trigger-features-v3-docs.mintlify.site/v3/quick-start.md): How to get started in 3 minutes using the CLI and SDK. - [Reattempting & Replaying](https://trigger-features-v3-docs.mintlify.site/v3/reattempting-replaying.md): 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. - [trigger.dev build](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-build.md): This command will build your tasks. - [trigger.dev deploy](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-deploy.md): This command will deploy your tasks. - [trigger.dev dev](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-dev.md): This command runs your tasks locally. - [trigger.dev init](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-init.md): This command will setup your v3 project. - [trigger.dev login](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-login.md): This command will log you in to the CLI. Required to run any other command. - [trigger.dev logout](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-logout.md): This command will log you out of the CLI. - [trigger.dev update](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-update.md): This command can be used to update all of your trigger.dev packages to the latest versions. - [trigger.dev whoami](https://trigger-features-v3-docs.mintlify.site/v3/reference-cli-who-am-i.md): This command will return information about you, the logged in user. - [Context](https://trigger-features-v3-docs.mintlify.site/v3/reference-context.md): The Context object is part of the `run` function parameter and provides information about the current run. - [cron.dynamic()](https://trigger-features-v3-docs.mintlify.site/v3/reference-cron-dynamic.md): Trigger a task with many different CRON schedules. For example you can use this to let your users select when they want a reminder. - [cron.task()](https://trigger-features-v3-docs.mintlify.site/v3/reference-cron-task.md): Trigger a task on a recurring schedule using a CRON expression. - [interval.dynamic()](https://trigger-features-v3-docs.mintlify.site/v3/reference-interval-dynamic.md): Trigger a task with many different interval schedules. For example you can use this to let your users select how often they want a reminder. - [interval.task()](https://trigger-features-v3-docs.mintlify.site/v3/reference-interval-task.md): Trigger a task on a recurring schedule using the time interval you want between runs. - [notification.catalog()](https://trigger-features-v3-docs.mintlify.site/v3/reference-notification-catalog.md): Create a set of events that can be emitted from your tasks. These can be subscribed to from your application to provide real-time updates to your users. - [notify()](https://trigger-features-v3-docs.mintlify.site/v3/reference-notify.md): Send a notification from your tasks. These can be subscribed to from your application to provide real-time updates to your users. - [queue()](https://trigger-features-v3-docs.mintlify.site/v3/reference-queue.md): Create queue settings that can be used when triggering a task. - [retry.fetch()](https://trigger-features-v3-docs.mintlify.site/v3/reference-retry-fetch.md): Inside a task, do a fetch request that will retry (you can specify the retry conditions). - [retry.interceptFetch()](https://trigger-features-v3-docs.mintlify.site/v3/reference-retry-intercept-fetch.md): Useful when writing automated tests – it will intercept matching HTTP requests and respond with what you provide. - [retry.onThrow()](https://trigger-features-v3-docs.mintlify.site/v3/reference-retry-on-throw.md): Inside a task, retry the wrapped code if it throws an error. - [task()](https://trigger-features-v3-docs.mintlify.site/v3/reference-task.md): The task() function is the simplest way to create a long-running task. - [task.batchTrigger()](https://trigger-features-v3-docs.mintlify.site/v3/reference-task-batch-trigger.md): Trigger a task many times at once from your code. - [task.batchTriggerAndWait()](https://trigger-features-v3-docs.mintlify.site/v3/reference-task-batch-trigger-and-wait.md): Trigger a task many times at once from inside another task, and wait for all the results. - [task.trigger()](https://trigger-features-v3-docs.mintlify.site/v3/reference-task-trigger.md): Trigger a task from your code. - [task.triggerAndWait()](https://trigger-features-v3-docs.mintlify.site/v3/reference-task-trigger-and-wait.md): Trigger a task from inside another task, and wait for the result. - [The trigger.config.js file](https://trigger-features-v3-docs.mintlify.site/v3/reference-trigger-config.md): This file is used to configure some settings for your project. - [wait.for()](https://trigger-features-v3-docs.mintlify.site/v3/reference-wait-for.md): Inside a task, wait for a period of time before continuing. - [wait.forEvent()](https://trigger-features-v3-docs.mintlify.site/v3/reference-wait-for-event.md): Inside a task, wait until a specific event is received before continuing. - [wait.forRequest()](https://trigger-features-v3-docs.mintlify.site/v3/reference-wait-for-request.md): Inside a task, wait until a specific request is received before continuing. - [wait.until()](https://trigger-features-v3-docs.mintlify.site/v3/reference-wait-until.md): Inside a task, wait until the specified date before continuing. - [zod.catalog()](https://trigger-features-v3-docs.mintlify.site/v3/reference-zod-catalog.md): Create a set of events with names and payloads that are parsed using Zod schemas. - [zod.task()](https://trigger-features-v3-docs.mintlify.site/v3/reference-zod-task.md): A task where the payload is parsed using a zod schema. - [Rollbacks](https://trigger-features-v3-docs.mintlify.site/v3/rollbacks.md): You can rollback changes when errors happen, to give transactional guarantees to your operations. - [Run tests](https://trigger-features-v3-docs.mintlify.site/v3/run-tests.md): You can use the dashboard to run a test of your tasks. - [Tasks: Overview](https://trigger-features-v3-docs.mintlify.site/v3/tasks-overview.md): Tasks are functions that can run for a long time and provide strong resilience to failure. - [Regular tasks](https://trigger-features-v3-docs.mintlify.site/v3/tasks-regular.md): The simplest type of task which can be triggered from elsewhere in your code. - [Scheduled tasks](https://trigger-features-v3-docs.mintlify.site/v3/tasks-scheduled.md): A task that is triggered on a recurring schedule using CRON syntax or an interval. - [Webhook tasks](https://trigger-features-v3-docs.mintlify.site/v3/tasks-webhooks.md): A task that is triggered when a webhook is received from an API. - [Zod tasks](https://trigger-features-v3-docs.mintlify.site/v3/tasks-zod.md): You can use Zod to define a catalog of events and then attach those events to your tasks. - [Trigger filters](https://trigger-features-v3-docs.mintlify.site/v3/trigger-filters.md): You can add filters to your tasks so they're only triggered when certain conditions are met. - [/trigger folders](https://trigger-features-v3-docs.mintlify.site/v3/trigger-folder.md): Your tasks live inside /trigger folders. Code in these is bundled and deployed together. - [Triggering](https://trigger-features-v3-docs.mintlify.site/v3/triggering.md): Tasks need to be triggered to run. - [Upgrading from v2](https://trigger-features-v3-docs.mintlify.site/v3/upgrading-from-v2.md): How to upgrade your v2 jobs to v3 tasks. - [Using APIs](https://trigger-features-v3-docs.mintlify.site/v3/using-apis.md): You can use any Node.js library inside the run function, or do HTTP requests. - [Vercel integration](https://trigger-features-v3-docs.mintlify.site/v3/vercel-integration.md): When you deploy to Vercel, automatically deploy your associated tasks. - [Versioning](https://trigger-features-v3-docs.mintlify.site/v3/versioning.md): We use atomic versioning to ensure that started tasks are not affected by changes to the task code. - [Wait: Overview](https://trigger-features-v3-docs.mintlify.site/v3/wait.md): During your run you can wait for a period of time or for something to happen. - [Wait for](https://trigger-features-v3-docs.mintlify.site/v3/wait-for.md): Wait for a period of time, then continue execution. - [Wait for event](https://trigger-features-v3-docs.mintlify.site/v3/wait-for-event.md): Wait until an event has been received, then continue execution. - [Wait for request](https://trigger-features-v3-docs.mintlify.site/v3/wait-for-request.md): Wait until a `Request` has been received at the provided URL, then continue execution. - [Wait until](https://trigger-features-v3-docs.mintlify.site/v3/wait-until.md): Wait until a date, then continue execution. - [Writing tasks: Introduction](https://trigger-features-v3-docs.mintlify.site/v3/writing-tasks-introduction.md): Tasks are the core of Trigger.dev. They are long-running processes that are triggered by events. ## OpenAPI Specs - [openapi](https://trigger-features-v3-docs.mintlify.site/openapi.yml) ## Optional - [Examples](https://trigger.dev/apis)