Create Schedule

Create a new schedule based on the specified options.

Authorizations

Authorization

string

header

required

Use your Secret API key in the form 'Bearer <SECRET KEY>' (without the quotation marks)

Body

application/json

task

string

required

cron

string

required

deduplicationKey

string

externalId

string

Response

200

application/json

Schedule created successfully

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

Show child attributes

generator.type

enum<string>

Available options:

CRON

generator.expression

string

The cron expression used to generate the schedule

generator.description

string

The description of the generator in plain english

nextRun

string

The next time the schedule will run

environments

object[]

Show child attributes

environments.id

string

environments.type

string

environments.userName

string