Deactivate Schedule

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

The ID of the schedule.

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

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

The type of schedule, DECLARATIVE or IMPERATIVE. Declarative schedules are declared in your code by setting the cron property on a schedules.task. Imperative schedules are created in the dashboard or by using the imperative SDK functions like schedules.create().

Whether the schedule is active or not

The deduplication key used to prevent creating duplicate schedules

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

Defaults to UTC. In IANA format, if set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.

The next time the schedule will run