AptlyStar

Trigger.dev

Trigger tasks and manage runs and schedules

使用方法

Integrate Trigger.dev into the workflow. Trigger and batch trigger background tasks, retrieve and control runs (cancel, replay, reschedule, tags, metadata, events, traces), manage cron schedules, environment variables, queues, deployments, and waitpoint tokens, and query run data with TRQL.

ツール

trigger_dev_trigger_task

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
taskIdentifierstringはいIdentifier of the task to trigger (e.g., "send-welcome-email")
payloadjsonいいえJSON payload passed to the task run. Example: {"userId": "user_123"}
idempotencyKeystringいいえIdempotency key that ensures the task is only triggered once per key
queuestringいいえName of the queue to run the task on
concurrencyKeystringいいえKey that scopes the queue concurrency limit (e.g., a user ID)
delaystringいいえDelay before the run executes, as a duration ("30m", "1h", "2d") or an ISO 8601 date
ttlstringいいえTime-to-live before an unstarted run expires, as a duration ("1h42m") or seconds
machinestringいいえMachine preset for the run: micro, small-1x, small-2x, medium-1x, medium-2x, large-1x, or large-2x
tagsstringいいえComma-separated tags to attach to the run (max 10, each under 128 characters)

出力

パラメータ型説明
idstringID of the run that was triggered (starts with run_)

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
taskIdentifierstringはいIdentifier of the task to batch trigger (e.g., "send-welcome-email")
itemsjsonはいJSON array of batch items (max 1,000). Each item is an object with a "payload" and optional "options" (queue, concurrencyKey, idempotencyKey, ttl, delay, tags, machine). Example: [{"payload": {"userId": "user_1"}}, {"payload": {"userId": "user_2"}, "options": {"delay": "1h"}}]

出力

パラメータ型説明
batchIdstringID of the batch that was triggered
runIdsarrayIDs of the runs created by the batch

trigger_dev_get_batch

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
batchIdstringはいID of the batch to retrieve (starts with batch_)

出力

パラメータ型説明
idstringID of the batch (starts with batch_)
statusstringBatch status (PENDING, PROCESSING, COMPLETED, PARTIAL_FAILED, or ABORTED)
idempotencyKeystringIdempotency key provided when triggering the batch
createdAtstringISO timestamp when the batch was created
updatedAtstringISO timestamp when the batch was last updated
runCountnumberTotal number of runs in the batch
runIdsarrayIDs of the runs in the batch
successfulRunCountnumberNumber of successful runs, populated after completion
failedRunCountnumberNumber of failed runs, populated after completion
errorsarrayError details for failed items, present for PARTIAL_FAILED batches
↳ indexnumberIndex of the failed item
↳ taskIdentifierstringTask identifier of the failed item
↳ errorjsonError details
↳ errorCodestringOptional error code

trigger_dev_get_batch_results

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
batchIdstringはいID of the batch to retrieve results for (starts with batch_)

出力

パラメータ型説明
idstringID of the batch (starts with batch_)
itemsarrayExecution results for each run in the batch

trigger_dev_get_run

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to retrieve (starts with run_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to retrieve the result for (starts with run_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_get_run_events

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to retrieve events for (starts with run_)

出力

パラメータ型説明
eventsarrayLog and span events recorded during the run
↳ spanIdstringSpan ID of the event
↳ parentIdstringParent span ID
↳ runIdstringRun ID associated with the event
↳ messagestringEvent message
↳ startTimestringStart time as a bigint string (nanoseconds since epoch)
↳ durationnumberDuration of the event in nanoseconds
↳ isErrorbooleanWhether the event represents an error
↳ isPartialbooleanWhether the event is still in progress
↳ isCancelledbooleanWhether the event was cancelled
↳ levelstringLog level (TRACE, DEBUG, LOG, INFO, WARN, or ERROR)
↳ kindstringKind of span event
↳ attemptNumbernumberAttempt number the event belongs to
↳ taskSlugstringTask identifier
↳ eventsarraySpan events (e.g., exceptions) that occurred during this event
↳ namestringEvent name
↳ timestringWhen the event occurred

trigger_dev_get_run_trace

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to retrieve the trace for (starts with run_)

出力

パラメータ型説明
traceIdstringOpenTelemetry trace ID of the run
rootSpanjsonRoot span of the trace; each span has id, parentId, runId, data (message, taskSlug, startTime, duration, isError, level, events), and recursively nested children spans

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
statusstringいいえComma-separated run statuses to filter by: PENDING_VERSION, DELAYED, QUEUED, EXECUTING, REATTEMPTING, FROZEN, COMPLETED, CANCELED, FAILED, CRASHED, INTERRUPTED, SYSTEM_FAILURE
taskIdentifierstringいいえComma-separated task identifiers to filter by
versionstringいいえComma-separated worker versions to filter by (e.g., "20240101.1")
tagstringいいえComma-separated tags to filter by
schedulestringいいえSchedule ID to filter by (starts with sched_)
isTeststringいいえFilter by test runs: "true" for only test runs, "false" to exclude them
periodstringいいえOnly return runs created in the given period (e.g., "1h", "7d")
fromstringいいえOnly return runs created on or after this ISO 8601 timestamp
tostringいいえOnly return runs created on or before this ISO 8601 timestamp
pageSizenumberいいえNumber of runs per page (max 100, default 25)
pageAfterstringいいえRun ID to start the page after, for forward pagination
pageBeforestringいいえRun ID to start the page before, for backward pagination

出力

パラメータ型説明
runsarrayRuns matching the filters
paginationobjectCursor pagination details
↳ nextstringRun ID to start the next page after
↳ previousstringRun ID to start the previous page before

trigger_dev_cancel_run

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to cancel (starts with run_)

出力

パラメータ型説明
idstringID of the run that was canceled

trigger_dev_replay_run

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to replay (starts with run_)

出力

パラメータ型説明
idstringID of the new run created by the replay

trigger_dev_reschedule_run

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the delayed run to reschedule (starts with run_)
delaystringはいNew delay for the run, as a duration ("30m", "1h", "2d") or an ISO 8601 date to delay until

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_add_run_tags

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to tag (starts with run_)
tagsstringはいComma-separated tags to add to the run (max 10 total, each under 128 characters)

出力

パラメータ型説明
messagestringConfirmation message for the added tags

trigger_dev_update_run_metadata

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
runIdstringはいID of the run to update (starts with run_)
metadatajsonはいJSON object to set as the run metadata. Example: {"stage": "approved"}

出力

パラメータ型説明
metadatajsonThe updated metadata of the run

trigger_dev_create_schedule

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
taskstringはいIdentifier of the task to schedule (e.g., "daily-report")
cronstringはいCron expression defining when the task runs (e.g., "0 0 * * *")
timezonestringいいえIANA timezone the cron expression is evaluated in (e.g., "America/New_York"). Defaults to UTC
externalIdstringいいえExternal identifier to associate with the schedule (e.g., a user ID)
deduplicationKeystringはいKey that prevents duplicate schedules; creating again with the same key updates the existing schedule

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_get_schedule

Retrieve a Trigger.dev schedule by its ID.

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
scheduleIdstringはいID of the schedule to retrieve (starts with sched_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_list_schedules

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
pagenumberいいえPage number to return (default 1)
perPagenumberいいえNumber of schedules per page

出力

パラメータ型説明
schedulesarraySchedules in the project
↳ idstringUnique ID of the schedule (starts with sched_)
↳ taskstringIdentifier of the task the schedule triggers
↳ typestringSchedule type (DECLARATIVE or IMPERATIVE)
↳ activebooleanWhether the schedule is active
↳ deduplicationKeystringDeduplication key of the schedule
↳ externalIdstringExternal ID associated with the schedule
↳ cronstringCron expression of the schedule
↳ cronDescriptionstringHuman-readable description of the cron expression
↳ timezonestringIANA timezone of the schedule
↳ nextRunstringISO timestamp of the next scheduled run
↳ environmentsarrayEnvironments the schedule runs in
↳ idstringEnvironment ID
↳ typestringEnvironment type
↳ userNamestringUsername for dev environments
paginationobjectPage-based pagination details
↳ currentPagenumberCurrent page number
↳ totalPagesnumberTotal number of pages
↳ countnumberTotal number of schedules

trigger_dev_update_schedule

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
scheduleIdstringはいID of the schedule to update (starts with sched_)
taskstringはいIdentifier of the task the schedule triggers (e.g., "daily-report")
cronstringはいCron expression defining when the task runs (e.g., "0 0 * * *")
timezonestringいいえIANA timezone the cron expression is evaluated in (e.g., "America/New_York"). Defaults to UTC
externalIdstringいいえExternal identifier to associate with the schedule (e.g., a user ID)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_delete_schedule

Delete an imperative Trigger.dev schedule by its ID.

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
scheduleIdstringはいID of the schedule to delete (starts with sched_)

出力

パラメータ型説明
deletedbooleanWhether the schedule was deleted
scheduleIdstringID of the schedule that was deleted

trigger_dev_activate_schedule

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
scheduleIdstringはいID of the schedule to activate (starts with sched_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_deactivate_schedule

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
scheduleIdstringはいID of the schedule to deactivate (starts with sched_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
projectRefstringはいExternal ref of the project, from the project settings (starts with proj_)
environmentstringはいEnvironment to list variables for: dev, staging, or prod

出力

パラメータ型説明
variablesarrayEnvironment variables in the project environment
↳ namestringName of the environment variable
↳ valuestringPlaintext value of the environment variable; appears in workflow outputs and run history

trigger_dev_create_env_var

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
projectRefstringはいExternal ref of the project, from the project settings (starts with proj_)
environmentstringはいEnvironment to create the variable in: dev, staging, or prod
namestringはいName of the environment variable (e.g., "SLACK_API_KEY")
valuestringはいValue of the environment variable

出力

パラメータ型説明
successbooleanWhether the environment variable was created
namestringName of the environment variable that was created

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
projectRefstringはいExternal ref of the project, from the project settings (starts with proj_)
environmentstringはいEnvironment to read the variable from: dev, staging, or prod
namestringはいName of the environment variable (e.g., "SLACK_API_KEY")

出力

パラメータ型説明
namestringName of the environment variable
valuestringPlaintext value of the environment variable; appears in workflow outputs and run history

trigger_dev_update_env_var

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
projectRefstringはいExternal ref of the project, from the project settings (starts with proj_)
environmentstringはいEnvironment the variable belongs to: dev, staging, or prod
namestringはいName of the environment variable to update (e.g., "SLACK_API_KEY")
valuestringはいNew value of the environment variable

出力

パラメータ型説明
successbooleanWhether the environment variable was updated
namestringName of the environment variable that was updated

trigger_dev_delete_env_var

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
projectRefstringはいExternal ref of the project, from the project settings (starts with proj_)
environmentstringはいEnvironment the variable belongs to: dev, staging, or prod
namestringはいName of the environment variable to delete (e.g., "SLACK_API_KEY")

出力

パラメータ型説明
successbooleanWhether the environment variable was deleted
namestringName of the environment variable that was deleted

trigger_dev_import_env_vars

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
projectRefstringはいExternal ref of the project, from the project settings (starts with proj_)
environmentstringはいEnvironment to upload the variables to: dev, staging, or prod
variablesjsonはいJSON array of environment variables to upload. Example: [{"name": "SLACK_API_KEY", "value": "slack_123"}]
overridestringいいえWhether to override existing variables: "true" or "false" (default false)

出力

パラメータ型説明
successbooleanWhether the environment variables were uploaded
countnumberNumber of environment variables submitted

trigger_dev_get_queue

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
queueNamestringはいQueue ID (starts with queue_), task identifier, or custom queue name, depending on the queue type
queueTypestringいいえHow to interpret the queue name: "id" (default) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_list_queues

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
pagenumberいいえPage number to return (default 1)
perPagenumberいいえNumber of queues per page

出力

パラメータ型説明
queuesarrayQueues in the environment
↳ idstringUnique ID of the queue (starts with queue_)
↳ namestringName of the queue
↳ typestringQueue type (task for task-default queues, custom for named queues)
↳ runningnumberNumber of runs currently executing
↳ queuednumberNumber of runs waiting in the queue
↳ pausedbooleanWhether the queue is paused
↳ concurrencyLimitnumberMaximum number of runs that can execute concurrently
↳ concurrencyobjectConcurrency details for the queue
↳ currentnumberCurrent concurrency limit
↳ basenumberBase concurrency limit
↳ overridenumberOverridden concurrency limit
↳ overriddenAtstringISO timestamp when the concurrency limit was overridden
paginationobjectPage-based pagination details
↳ currentPagenumberCurrent page number
↳ totalPagesnumberTotal number of pages
↳ countnumberTotal number of queues

trigger_dev_pause_queue

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
queueNamestringはいQueue ID (starts with queue_), task identifier, or custom queue name, depending on the queue type
queueTypestringいいえHow to interpret the queue name: "id" (default) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_resume_queue

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
queueNamestringはいQueue ID (starts with queue_), task identifier, or custom queue name, depending on the queue type
queueTypestringいいえHow to interpret the queue name: "id" (default) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_override_queue_concurrency

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
queueNamestringはいQueue ID (starts with queue_), task identifier, or custom queue name, depending on the queue type
queueTypestringいいえHow to interpret the queue name: "id" (default) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name
concurrencyLimitnumberはいNew concurrency limit for the queue (0 to 100000)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_reset_queue_concurrency

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
queueNamestringはいQueue ID (starts with queue_), task identifier, or custom queue name, depending on the queue type
queueTypestringいいえHow to interpret the queue name: "id" (default) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_list_deployments

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
statusstringいいえDeployment status to filter by: PENDING, BUILDING, DEPLOYING, DEPLOYED, FAILED, CANCELED, or TIMED_OUT
periodstringいいえOnly return deployments created in the given period (e.g., "1h", "7d")
fromstringいいえOnly return deployments created on or after this ISO 8601 timestamp
tostringいいえOnly return deployments created on or before this ISO 8601 timestamp
pageSizenumberいいえNumber of deployments per page (5 to 100, default 20)
pageAfterstringいいえCursor to start the page after, from the previous response pagination

出力

パラメータ型説明
deploymentsarrayDeployments matching the filters
paginationobjectCursor pagination details
↳ nextstringCursor to pass as the page-after parameter for the next page

trigger_dev_get_deployment

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
deploymentIdstringはいID of the deployment to retrieve

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_get_latest_deployment

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_promote_deployment

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
versionstringはいDeployment version to promote (e.g., "20250228.1")

出力

パラメータ型説明
idstringID of the promoted deployment
versionstringVersion of the promoted deployment
shortCodestringShort code of the promoted deployment

trigger_dev_execute_query

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
querystringはいTRQL query to execute (e.g., "SELECT run_id, status, triggered_at FROM runs WHERE status = 'Failed' LIMIT 10")
scopestringいいえScope of data to query: environment (default), project, or organization
periodstringいいえTime period shorthand (e.g., "1h", "7d", "30d"). Cannot be combined with from/to
fromstringいいえStart of the time range as an ISO 8601 timestamp. Must be used with "to"
tostringいいえEnd of the time range as an ISO 8601 timestamp. Must be used with "from"
formatstringいいえResponse format: "json" (default) for structured rows or "csv" for a CSV string

出力

パラメータ型説明
formatstringFormat of the results (json or csv)
resultsjsonQuery results: an array of row objects for json format, a CSV string for csv

trigger_dev_get_query_schema

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)

出力

パラメータ型説明
tablesarrayTables that can be queried with TRQL
↳ namestringTable name used in TRQL queries
↳ descriptionstringDescription of the table
↳ timeColumnstringPrimary time column for the table
↳ columnsarrayColumns of the table
↳ namestringColumn name
↳ typestringClickHouse data type
↳ descriptionstringColumn description
↳ examplestringExample value
↳ allowedValuesarrayAllowed values for enum-like columns
↳ coreColumnbooleanWhether the column is included in default queries

trigger_dev_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).

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
timeoutstringいいえHow long before the token times out, as a duration ("30s", "1m", "2h", "3d") or an ISO 8601 date
idempotencyKeystringいいえIdempotency key; passing the same key before it expires returns the original token
idempotencyKeyTTLstringいいえHow long the idempotency key is valid, as a duration ("30s", "1m", "2h", "3d")
tagsstringいいえComma-separated tags to attach to the waitpoint (max 10, each under 128 characters)

出力

パラメータ型説明
idstringUnique ID of the waitpoint token (starts with waitpoint_)
isCachedbooleanWhether an existing token was returned because the same idempotency key was reused
urlstringHTTP callback URL; a POST request to this URL completes the waitpoint without an API key

trigger_dev_complete_waitpoint_token

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
waitpointIdstringはいID of the waitpoint token to complete (starts with waitpoint_)
datajsonいいえJSON data passed back to the waiting run as the token result. Example: {"status": "approved"}

出力

パラメータ型説明
successbooleanWhether the waitpoint token was completed

trigger_dev_get_waitpoint_token

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
waitpointIdstringはいID of the waitpoint token to retrieve (starts with waitpoint_)

出力

パラメータ型説明
idstringRun, schedule, or queue ID
batchIdstringBatch ID (Batch Trigger Task)
runIdsjsonRun IDs in the batch (batch operations)
runCountnumberTotal number of runs in the batch (Get Batch)
successfulRunCountnumberNumber of successful runs in the batch (Get Batch)
failedRunCountnumberNumber of failed runs in the batch (Get Batch)
errorsjsonError details for failed batch items (Get Batch)
itemsjsonExecution results for each run in the batch (Get Batch Results)
statusstringRun status (Get Run)
taskIdentifierstringTask identifier of the run (Get Run)
createdAtstringWhen the run was created (Get Run)
startedAtstringWhen the run started (Get Run)
finishedAtstringWhen the run finished (Get Run)
durationMsnumberCompute duration in milliseconds (Get Run)
costInCentsnumberCompute cost in cents (Get Run)
isTestbooleanWhether the run is a test run (Get Run)
tagsjsonTags attached to the run (Get Run)
payloadjsonPayload the run was triggered with (Get Run)
outputjsonOutput returned by the run (Get Run)
attemptsjsonAttempts made for the run (Get Run)
metadatajsonRun metadata (Get Run, Update Run Metadata)
okbooleanWhether the run succeeded (Get Run Result)
outputTypestringContent type of the run output (Get Run Result)
errorjsonError details for a failed run (Get Run Result)
messagestringConfirmation message (Add Run Tags)
eventsjsonLog and span events of the run (Get Run Events)
traceIdstringOpenTelemetry trace ID (Get Run Trace)
rootSpanjsonRoot span of the run trace (Get Run Trace)
runsjsonRuns matching the filters (List Runs)
schedulesjsonSchedules in the project (List Schedules)
paginationjsonPagination details (list operations)
taskstringTask the schedule triggers (schedule operations)
activebooleanWhether the schedule is active (schedule operations)
cronstringCron expression (schedule operations)
cronDescriptionstringHuman-readable cron description (schedule operations)
timezonestringTimezone of the schedule (schedule operations)
nextRunstringNext scheduled run time (schedule operations)
environmentsjsonEnvironments the schedule runs in (schedule operations)
deletedbooleanWhether the schedule was deleted (Delete Schedule)
variablesjsonEnvironment variables in the project environment (List Env Vars)
namestringEnvironment variable or queue name (env var and queue operations)
valuestringValue of the environment variable (Get Env Var)
successbooleanWhether the operation succeeded (env var operations, Complete Waitpoint Token)
countnumberNumber of environment variables submitted (Import Env Vars)
queuesjsonQueues in the environment (List Queues)
runningnumberRuns currently executing (queue operations)
queuednumberRuns waiting in the queue (queue operations)
pausedbooleanWhether the queue is paused (queue operations)
concurrencyLimitnumberConcurrency limit of the queue (queue operations)
concurrencyjsonConcurrency details of the queue (queue operations)
deploymentsjsonDeployments matching the filters (List Deployments)
versionstringDeployment version (deployment operations)
shortCodestringDeployment short code (deployment operations)
tasksjsonTasks registered by the deployed worker (deployment operations)
formatstringFormat of the query results (Execute Query)
resultsjsonQuery results (Execute Query)
tablesjsonQueryable TRQL tables and columns (Get Query Schema)
tokensjsonWaitpoint tokens (List Waitpoint Tokens)
urlstringWaitpoint callback URL (waitpoint operations)
isCachedbooleanWhether an existing token was returned (Create Waitpoint Token)
timezonesjsonSupported IANA timezones (List Timezones)

trigger_dev_list_waitpoint_tokens

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
statusstringいいえWaitpoint status to filter by: WAITING, COMPLETED, or TIMED_OUT
idempotencyKeystringいいえIdempotency key to filter by
tagsstringいいえComma-separated tags to filter by
periodstringいいえOnly return tokens created in the given period (e.g., "1h", "7d")
fromstringいいえOnly return tokens created on or after this ISO 8601 timestamp
tostringいいえOnly return tokens created on or before this ISO 8601 timestamp
pageSizenumberいいえNumber of tokens per page (max 100)
pageAfterstringいいえWaitpoint ID to start the page after, for forward pagination
pageBeforestringいいえWaitpoint ID to start the page before, for backward pagination

出力

パラメータ型説明
tokensarrayWaitpoint tokens matching the filters
paginationobjectCursor pagination details
↳ nextstringWaitpoint ID to start the next page after
↳ previousstringWaitpoint ID to start the previous page before

trigger_dev_list_timezones

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

入力

パラメータ型必須説明
apiKeystringはいTrigger.dev secret API key (starts with tr_)
excludeUtcstringいいえSet to "true" to exclude UTC from the returned timezones

出力

パラメータ型説明
timezonesarrayIANA timezones supported by schedules

On this page

使用方法
ツール
trigger_dev_trigger_task
入力
出力
trigger_dev_batch_trigger_task
入力
出力
trigger_dev_get_batch
入力
出力
trigger_dev_get_batch_results
入力
出力
trigger_dev_get_run
入力
出力
trigger_dev_get_run_result
入力
出力
trigger_dev_get_run_events
入力
出力
trigger_dev_get_run_trace
入力
出力
trigger_dev_list_runs
入力
出力
trigger_dev_cancel_run
入力
出力
trigger_dev_replay_run
入力
出力
trigger_dev_reschedule_run
入力
出力
trigger_dev_add_run_tags
入力
出力
trigger_dev_update_run_metadata
入力
出力
trigger_dev_create_schedule
入力
出力
trigger_dev_get_schedule
入力
出力
trigger_dev_list_schedules
入力
出力
trigger_dev_update_schedule
入力
出力
trigger_dev_delete_schedule
入力
出力
trigger_dev_activate_schedule
入力
出力
trigger_dev_deactivate_schedule
入力
出力
trigger_dev_list_env_vars
入力
出力
trigger_dev_create_env_var
入力
出力
trigger_dev_get_env_var
入力
出力
trigger_dev_update_env_var
入力
出力
trigger_dev_delete_env_var
入力
出力
trigger_dev_import_env_vars
入力
出力
trigger_dev_get_queue
入力
出力
trigger_dev_list_queues
入力
出力
trigger_dev_pause_queue
入力
出力
trigger_dev_resume_queue
入力
出力
trigger_dev_override_queue_concurrency
入力
出力
trigger_dev_reset_queue_concurrency
入力
出力
trigger_dev_list_deployments
入力
出力
trigger_dev_get_deployment
入力
出力
trigger_dev_get_latest_deployment
入力
出力
trigger_dev_promote_deployment
入力
出力
trigger_dev_execute_query
入力
出力
trigger_dev_get_query_schema
入力
出力
trigger_dev_create_waitpoint_token
入力
出力
trigger_dev_complete_waitpoint_token
入力
出力
trigger_dev_get_waitpoint_token
入力
出力
trigger_dev_list_waitpoint_tokens
入力
出力
trigger_dev_list_timezones
入力
出力