Sign in to run requests with your own sandbox key. Sign in

Workflow

Type: Workflow

Workflow has 9 top-level fields; id, object, name, active, trigger_type are always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 7 operations, listed under Used by. The machine-readable definition is #/components/schemas/Workflow in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • id integer required
  • object string required
  • code string, nullable Short human-readable code assigned by Cascades.
  • name string required
  • active boolean required `true` = activated and triggerable in live mode. Drafts (`false`) can still be triggered in test mode.
  • trigger_type string required One of manual event scheduled
  • use_case string, nullable
  • created_at string (date-time)
  • updated_at string (date-time)

Used by

Was this page helpful?