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

const updatedSchedule = await schedules.update(scheduleId, {
  task: 'my-updated-task',
  cron: '0 0 * * *'
});
{
  "id": "sched_1234",
  "task": "my-scheduled-task",
  "active": true,
  "deduplicationKey": "dedup_key_1234",
  "externalId": "user_1234",
  "generator": {
    "type": "CRON",
    "expression": "0 0 * * *",
    "description": "Every day at midnight"
  },
  "nextRun": "2024-04-01T00:00:00Z",
  "environments": [
    {
      "id": "<string>",
      "type": "<string>",
      "userName": "<string>"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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({ secretKey: "tr_dev_1234" });

Path Parameters

schedule_id
string
required

The ID of the schedule.

Body

application/json
task
string
required
cron
string
required
deduplicationKey
string
externalId
string

Response

200 - application/json
id
string

The unique ID of the schedule, prefixed with 'sched_'

task
string

The id of the scheduled task that will be triggered by this schedule

active
boolean

Whether the schedule is active or not

deduplicationKey
string

The deduplication key used to prevent creating duplicate schedules

externalId
string

The external ID of the schedule. Can be anything that is useful to you (e.g., user ID, org ID, etc.)

generator
object
nextRun
string

The next time the schedule will run

environments
object[]