Batch trigger

POST

api

tasks

batch

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.batchTrigger([
  {
    payload: { message: "Hello, world!" },
    options: {
      idempotencyKey: "unique-key-123",
      concurrencyKey: "user-123-task",
      queue: {
        name: "my-task-queue",
        concurrencyLimit: 5
      }
    }
  }
]);

{
  "batchId": "batch_1234",
  "runs": [
    "<string>"
  ]
}

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" });

Body

application/json

items

object[]

required

An array of payloads to trigger the task with

items.task

string

required

The task identifier to trigger. This is the id set in your task() functions.

items.payload

any

The payload can include any valid JSON

items.context

any

The context can include any valid JSON

items.options

object

Response

200

application/json

Task batch triggered successfully

batchId

string

required

The ID of the batch that was triggered

runs

string[]

required

An array of run IDs that were triggered

Was this page helpful?

Suggest edits Raise issue

List runsList runs in a specific environment. You can filter the runs by status, created at, task identifier, version, and more.

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.batchTrigger([
  {
    payload: { message: "Hello, world!" },
    options: {
      idempotencyKey: "unique-key-123",
      concurrencyKey: "user-123-task",
      queue: {
        name: "my-task-queue",
        concurrencyLimit: 5
      }
    }
  }
]);

{
  "batchId": "batch_1234",
  "runs": [
    "<string>"
  ]
}

API reference

Tasks API

Runs API

Schedules API

Env Vars API

Authorizations

Body

Response