Overview

Using the Trigger.dev management API

Installation

The management API is available through the same @trigger.dev/sdk package used in defining and triggering tasks. If you have already installed the package in your project, you can skip this step.

npm

npm i @trigger.dev/sdk@latest

pnpm add @trigger.dev/sdk@latest

yarn add @trigger.dev/sdk@latest

Usage

All v3 functionality is provided through the @trigger.dev/sdk module. You can import the entire module or individual resources as needed.

import { configure, runs } from "@trigger.dev/sdk";

configure({
  // this is the default and if the `TRIGGER_SECRET_KEY` environment variable is set, can omit calling configure
  secretKey: process.env["TRIGGER_SECRET_KEY"],
});

async function main() {
  const runs = await runs.list({
    limit: 10,
    status: ["COMPLETED"],
  });
}

main().catch(console.error);