POST
/
api
/
v1
/
tasks
/
{taskIdentifier}
/
trigger
TypeScript
import { task } from "@trigger.dev/sdk";

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

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

Response

Task triggered successfully

​
id
string

The ID of the run that was triggered.

Example:

"run_1234"