Create Environment Variable

Overview

Creates a single environment variable for a specific project and environment. When called from inside a task, the projectRef and env arguments can be omitted and are inferred from the task’s runtime context. To create or update multiple variables in one request, use the upload (bulk import) endpoint instead.

Endpoint

POST https://api.trigger.dev/api/v1/projects/{projectRef}/envvars/{env}

Path parameters

string

required

The project reference (e.g. proj_yubjwjsfkxnylobaqvqz).

string

required

The target environment: dev, staging, prod, or preview.

Request body

string

required

The name of the environment variable (e.g. SLACK_API_KEY).

string

required

The value to assign.

Response

boolean

true when the variable was created successfully.

Examples

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

await envvars.create("proj_yubjwjsfkxnylobaqvqz", "prod", {
  name: "SLACK_API_KEY",
  value: "slack_123456",
});

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

export const myTask = task({
  id: "my-task",
  run: async () => {
    // projectRef and env are inferred from the task context
    await envvars.create({
      name: "SLACK_API_KEY",
      value: "slack_123456",
    });
  },
});

curl -X POST \
  "https://api.trigger.dev/api/v1/projects/proj_yubjwjsfkxnylobaqvqz/envvars/prod" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_dev_1234" \
  -d '{
    "name": "SLACK_API_KEY",
    "value": "slack_123456"
  }'

Response example

{
  "success": true
}

Operation	Endpoint
List variables	`GET /api/v1/projects/{projectRef}/envvars/{env}`
Retrieve variable	`GET /api/v1/projects/{projectRef}/envvars/{env}/{name}`
Update variable	`PUT /api/v1/projects/{projectRef}/envvars/{env}/{name}`
Delete variable	`DELETE /api/v1/projects/{projectRef}/envvars/{env}/{name}`
Bulk import	`POST /api/v1/projects/{projectRef}/envvars/{env}/import`

Preview branches

To create a variable scoped to a specific preview branch, include the x-trigger-branch header or set previewBranch in the SDK configuration.

SDK
cURL

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

configure({
  secretKey: process.env["TRIGGER_ACCESS_TOKEN"],
  previewBranch: "feature-xyz",
});

await envvars.create("proj_yubjwjsfkxnylobaqvqz", "preview", {
  name: "FEATURE_FLAG",
  value: "true",
});

curl -X POST \
  "https://api.trigger.dev/api/v1/projects/proj_yubjwjsfkxnylobaqvqz/envvars/preview" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_pat_1234" \
  -H "x-trigger-branch: feature-xyz" \
  -d '{"name": "FEATURE_FLAG", "value": "true"}'

Overview

Tasks & Runs

Schedules & Queues

Waitpoints & Env Vars

Create Environment Variable

Overview

Endpoint

Path parameters

Request body

Response

Examples

Response example

Preview branches

​Overview

​Endpoint

​Path parameters

​Request body

​Response

​Examples

​Response example

​Related operations

​Preview branches

Overview

Endpoint

Path parameters

Request body

Response

Examples

Response example

Related operations

Preview branches