Trigger.dev

Trigger Task

Trigger a Trigger.dev task by its identifier with an optional JSON payload. Returns the ID of the created run.

Batch Trigger Task

Batch trigger a Trigger.dev task with up to 1,000 payloads. All items in the batch run the same task. Returns the batch ID and the created run IDs.

Get Batch

Retrieve a Trigger.dev batch by its ID, including its status, run IDs, and success and failure counts.

Get Batch Results

Retrieve the execution results of every run in a Trigger.dev batch, including outputs and error details.

Get Run

Retrieve a Trigger.dev run by its ID, including status, payload, output, attempts, and timing details.

Get Run Result

Retrieve the result of a Trigger.dev run: whether it succeeded, its output, and error details. Lighter than Get Run when only the outcome is needed.

Get Run Events

Retrieve the log and span events of a Trigger.dev run, including messages, levels, durations, and error events.

Get Run Trace

Retrieve the OpenTelemetry trace of a Trigger.dev run as a tree of spans with timing, errors, and nested children.

List Runs

List Trigger.dev runs in the environment of the API key, with optional filters for status, task, version, tags, schedule, and creation time.

Cancel Run

Cancel an in-progress Trigger.dev run. Has no effect if the run is already completed.

Replay Run

Replay a Trigger.dev run, creating a new run with the same payload and options as the original.

Reschedule Run

Reschedule a delayed Trigger.dev run with a new delay. Only valid while the run is in the DELAYED state.

Add Run Tags

Add tags to an existing Trigger.dev run. Runs can have up to 10 tags.

Update Run Metadata

Replace the metadata of a Trigger.dev run with a new JSON object.

Create Schedule

Create an imperative cron schedule that triggers a Trigger.dev task on a recurring basis.

Get Schedule

Retrieve a Trigger.dev schedule by its ID.

List Schedules

List Trigger.dev schedules in the project, with page-based pagination.

Update Schedule

Update an imperative Trigger.dev schedule by its ID, replacing its task, cron expression, timezone, and external ID.

Delete Schedule

Delete an imperative Trigger.dev schedule by its ID.

Activate Schedule

Activate an imperative Trigger.dev schedule so it resumes triggering its task.

Deactivate Schedule

Deactivate an imperative Trigger.dev schedule so it stops triggering its task.

List Env Vars

List the environment variables of a Trigger.dev project environment. Values are returned in plaintext and will appear in workflow outputs and run history — scope this operation carefully.

Create Env Var

Create an environment variable in a Trigger.dev project environment.

Get Env Var

Retrieve an environment variable from a Trigger.dev project environment. The value is returned in plaintext and will appear in workflow outputs and run history.

Update Env Var

Update the value of an environment variable in a Trigger.dev project environment.

Delete Env Var

Delete an environment variable from a Trigger.dev project environment.

Import Env Vars

Upload multiple environment variables to a Trigger.dev project environment in one request.

Get Queue

Retrieve a Trigger.dev queue by ID, task identifier, or custom queue name, including its running and queued counts.

List Queues

List the queues in the environment of the API key, including running and queued counts, with page-based pagination.

Pause Queue

Pause a Trigger.dev queue so no new runs start. Runs that are currently executing continue to completion.

Resume Queue

Resume a paused Trigger.dev queue so new runs can start again.

Override Queue Concurrency

Override the concurrency limit of a Trigger.dev queue with a new value.

Reset Queue Concurrency

Reset the concurrency limit of a Trigger.dev queue back to its base value, removing any override.

List Deployments

List Trigger.dev deployments in the environment of the API key, with optional status and creation-time filters.

Get Deployment

Retrieve a Trigger.dev deployment by its ID, including its status, version, and registered tasks.

Get Latest Deployment

Retrieve the latest Trigger.dev deployment in the environment of the API key.

Promote Deployment

Promote a Trigger.dev deployment version so new runs execute on it (e.g., to roll back to a previous version).

Execute Query

Execute a TRQL (SQL-like) query against Trigger.dev run data for reporting and analytics.

Get Query Schema

Retrieve the TRQL query schema: the tables and columns available for Execute Query, with types and allowed values.

Create Waitpoint Token

Create a Trigger.dev waitpoint token that a task can wait on until it is completed from outside (e.g., a human approval).

Complete Waitpoint Token

Complete a Trigger.dev waitpoint token, resuming any task waiting on it and passing it optional JSON data.

Get Waitpoint Token

Retrieve a Trigger.dev waitpoint token by its ID, including its status, timeout, and completion data.

List Waitpoint Tokens

List Trigger.dev waitpoint tokens in the environment of the API key, with optional status, tag, and creation-time filters.

List Timezones

List the IANA timezones supported by Trigger.dev schedules, for use as the timezone of a cron schedule.