Management API overview - Trigger

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.

bash

npm i @trigger.dev/sdk@latest

bash

pnpm add @trigger.dev/sdk@latest

bash

yarn add @trigger.dev/sdk@latest

</CodeGroup>

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 completedRuns = await runs.list({
    limit: 10,
    status: ["COMPLETED"],
  });
}

main().catch(console.error);

Multiple clients in one process

If a single process needs to talk to more than one Trigger.dev project, environment, or preview branch, use new TriggerClient({...}) for each target instead of configure(). Each instance owns its own auth and config, with no shared global state. See Multiple SDK clients for the full pattern.

import { TriggerClient } from "@trigger.dev/sdk";

const prod = new TriggerClient({ accessToken: process.env.TRIGGER_PROD_KEY });
const preview = new TriggerClient({
  accessToken: process.env.TRIGGER_PREVIEW_KEY,
  previewBranch: "signup-flow",
});

const payload = { to: "[email protected]" };
await prod.tasks.trigger("send-email", payload);
await preview.runs.list({ status: ["COMPLETED"] });