Cascades Docs
Sign in to run requests with your own sandbox key. Sign in
View as Markdown Open in Claude Open in ChatGPT Add MCP server OpenAPI JSON OpenAPI YAML

TriggerRequest

All fields are optional; an empty body starts a test-mode run with an empty payload.

Type: TriggerRequest

TriggerRequest has 3 top-level fields. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 1 operation, listed under Used by. The machine-readable definition is #/components/schemas/TriggerRequest in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • payload object The decision input. Put the subject under `applicant`; arbitrary nested fields are allowed and become the execution's `input_context`. Defaults to `{}` when omitted.
    • applicant ApplicantPayload Free-form applicant data forwarded to the workflow's first node as `context.applicant`. Field names depend on the workflow definition.
    • property object Optional property / tenancy details (as returned by `listWorkflowTestCases`).
  • execution_mode string `test` uses synthetic vendor data and never bills; `live` requires production access and an active cascade. One of test live
  • external_reference string Your correlation id for this run. Echoed on the execution and on every webhook event.

Used by

Was this page helpful?