Skip to content

Rippling: Create a workflow — response body — definition kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years

Create a workflow: response body, field definition / kind: editable / trigger / kind: custom_schedule, unit: minutes, hours, days, weeks, months, years. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONOptional
day_of_month (anyOf 1)JSONAlternative
day_of_month (anyOf 1) (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
day_of_month (anyOf 2)nullAlternative
days_of_weekJSONOptional
days_of_week (anyOf 1)arrayAlternative
days_of_week (anyOf 1)[]JSONEach item
days_of_week (anyOf 1)[] (anyOf 1)integerAlternative
days_of_week (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
days_of_week (anyOf 2)nullAlternative
hourJSONOptional
hour (anyOf 1)integerAlternativeDefault: 0
Maximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalJSONRequired within parent
interval (anyOf 1)integerAlternativeMinimum: 1
interval (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: custom_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_yearJSONOptional
month_of_year (anyOf 1)JSONAlternative
month_of_year (anyOf 1) (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
month_of_year (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_year (anyOf 2)nullAlternative
start_monthJSONOptional
start_month (anyOf 1)JSONAlternative
start_month (anyOf 1) (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
start_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_month (anyOf 2)nullAlternative
timezonestringRequired within parent
unitstringRequired within parentKnown values: minutes, hours, days, weeks, months, years

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.