TriggerClient: getRun() instance method

The getRun() method gets the details for a given Run.

These are the docs for Trigger.dev v2 which will be deprecated on January 31st, 2025. You probably want the v3 docs.

Parameters

runId · string · required

The Run ID you want to get the details for

options · Object

Show properties

subtasks · boolean · default: false

Return subtasks, which appear in a subtasks array on every task.

cursor · string

You can use this to get more tasks, if there are more than are returned in a single batch.

take · number · default: 20

How many tasks you want to return in one go, max 50.

taskdetails · boolean · default: false

If true, it returns the params and output of all tasks.

Returns

id · string | undefined

The id of the run

status · RunStatus | undefined

The status of the run. Can be one of the following: PENDING, CANCELED, SUCCESS, QUEUED, WAITING_ON_CONNECTIONS, PREPROCESSING, STARTED, FAILURE, TIMED_OUT, ABORTED

startedAt · Date | undefined

The time the run started

completedAt · Date | undefined

The time the run completed

output · any

Whatever you returned from your run function, can be undefined

tasks · Task[]

The tasks from the run

Show Task

id · string

The Task id

displayKey · string | null

The key that you defined when creating the Task, the first param in any task.

status · TaskStatus

The Task status, can be one of PENDING, WAITING, RUNNING, COMPLETED, ERRORED, CANCELED.

name · string

The name of the Task

icon · string | null

The icon of the Task, a string. For integrations, this will be a lowercase name of the company. Can be used with the @trigger.dev/companyicons package to display an svg.

startedAt · Date | null

When the task started

completedAt · Date | null

When the task completed

nextCursor · string

If there are more tasks, you can use this to get them

getRun example

// jobs/myJobs.ts
client.defineJob({
  id: "my-job",
  ...
});

// someFile.ts
...
const runs = await client.getRuns("my-job");
if (runs.length === 0) {
  throw new Error("No runs found");
}

const runDetail = await client.getRun(runs[0].id);
console.log(runDetail.tasks.length);
...