Skip to content

Rippling: Create a workflow — request body — body

Create a workflow: request body, field body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a workflow — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
actionsarrayRequired within parentMaximum items: 160
Minimum items: 1
actions[]JSONEach item
actions[] (oneOf 1)ModelAlternativeExpand Create a workflow — request body — body / actions / item / kind: registered callback
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 3000
description (anyOf 2)nullAlternative
enabledbooleanOptionalDefault: false
namestringRequired within parentMaximum length: 150
Minimum length: 1
statusstringOptionalDefault: draft
One of: draft, published
triggerJSONRequired within parent
trigger (oneOf 1)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: annual schedule
trigger (oneOf 2)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: biweekly schedule
trigger (oneOf 3)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: business event
trigger (oneOf 4)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: cron schedule
trigger (oneOf 5)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years
trigger (oneOf 6)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: daily schedule
trigger (oneOf 7)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: inbound email
trigger (oneOf 8)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: manual
trigger (oneOf 9)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: monthly on day of week schedule
trigger (oneOf 10)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: monthly schedule
trigger (oneOf 11)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: one time schedule
trigger (oneOf 12)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: quarterly schedule
trigger (oneOf 13)ModelAlternativeExpand Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack
trigger (oneOf 14)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: weekday schedule
trigger (oneOf 15)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: weekly schedule

Referenced models: Create a workflow — request body — body / trigger / kind: annual schedule, Create a workflow — request body — body / trigger / kind: biweekly schedule, Create a workflow — request body — body / trigger / kind: business event, Create a workflow — request body — body / trigger / kind: cron schedule, Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years, Create a workflow — request body — body / trigger / kind: daily schedule, Create a workflow — request body — body / trigger / kind: inbound email, Create a workflow — request body — body / trigger / kind: manual, Create a workflow — request body — body / trigger / kind: monthly on day of week schedule, Create a workflow — request body — body / trigger / kind: monthly schedule, Create a workflow — request body — body / trigger / kind: one time schedule, Create a workflow — request body — body / trigger / kind: quarterly schedule, Create a workflow — request body — body / actions / item / kind: registered callback, Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack, Create a workflow — request body — body / trigger / kind: weekday schedule, Create a workflow — request body — body / trigger / kind: weekly schedule

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.