Trigger

POST

api

tasks

{taskIdentifier}

trigger

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

export const myTask = await task({
  id: "my-task",
  run: async (payload: { message: string }) => {
    console.log("Hello, world!");
  }
});

// Somewhere else in your code
await myTask.trigger({ message: "Hello, world!" }, {
  idempotencyKey: "unique-key-123",
  concurrencyKey: "user123-task",
  queue: {
    name: "my-task-queue",
    concurrencyLimit: 5
  },
});

{
  "id": "run_1234"
}

Authorizations

Authorization

string

header

required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

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

configure({ accessToken: "tr_dev_1234" });

Path Parameters

taskIdentifier

string

required

The id of a task

Body

application/json

payload

any

The payload can include any valid JSON

context

any

The context can include any valid JSON

options

object

options.queue

object

options.concurrencyKey

string

Scope the concurrency limit to a specific key.

options.idempotencyKey

string

An optional property that specifies the idempotency key used to prevent creating duplicate runs. If you provide an existing idempotency key, we will return the existing run ID.

options.ttl

The time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute. You can use a string in this format: 1h, 1m, 1h42m or a number of seconds (min. 1).

Example:

"1h42m"

options.delay

string

The delay before the task is executed. This can be a Date object, a string like 1h or a date-time string.

"1h" - 1 hour
"30d" - 30 days
"15m" - 15 minutes
"2w" - 2 weeks
"60s" - 60 seconds
new Date("2025-01-01T00:00:00Z")

options.tags

Tags to attach to the run. Tags can be used to filter runs in the dashboard and using the SDK.

You can set up to 5 tags per run, they must be less than 64 characters each.

We recommend prefixing tags with a namespace using an underscore or colon, like user_1234567 or org:9876543. Stripe uses underscores.

Example:

["user_123456", "product_4629101"]

options.machine

enum<string>

The machine preset to use for this run. This will override the task's machine preset and any defaults.

Available options:

micro,

small-1x,

small-2x,

medium-1x,

medium-2x,

large-1x,

large-2x

Example:

"small-2x"

Response

200

application/json

Task triggered successfully

string

The ID of the run that was triggered.

Example:

"run_1234"

Was this page helpful?

Suggest edits Raise issue

Batch triggerBatch trigger tasks with up to 500 payloads.

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

export const myTask = await task({
  id: "my-task",
  run: async (payload: { message: string }) => {
    console.log("Hello, world!");
  }
});

// Somewhere else in your code
await myTask.trigger({ message: "Hello, world!" }, {
  idempotencyKey: "unique-key-123",
  concurrencyKey: "user123-task",
  queue: {
    name: "my-task-queue",
    concurrencyLimit: 5
  },
});

{
  "id": "run_1234"
}

API reference

Tasks API

Runs API

Schedules API

Env Vars API

Authorizations

Path Parameters

Body

Response