Skip to main content
POST
Create a schedule

Authorizations

X-API-Key
string
header
required

Body

application/json

POST /schedules body. All fields required except optional ones.

definition_id
string
required
description
string
required
Required string length: 1 - 200
cron_expression
string
required
enabled
boolean
default:true
input_data
Input Data · object | null
metadata
Metadata · object

Response

Successful Response

A schedule. next_fire_at is computed from the cron expression at read time (never stored) and is null only if the stored expression cannot produce a future fire.

id
string
required
definition_id
string
required
org_id
string
required
description
string
required
cron_expression
string
required
enabled
boolean
required
input_data
Input Data · object | null
required
metadata
Metadata · object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
next_fire_at
string<date-time> | null
required
last_fired_at
string<date-time> | null
required
last_fire_status
enum<string> | null
required
Available options:
success,
failure,
running