WorkflowOverviewSheet

A sheet's operational settings within the parent workflow returned by Get Workflow Overview. `sheet_id` is the UUID to pass on sheet-scoped endpoints.

Properties

sheet_idstring <uuid>required

UUID of the sheet. Pass as `{sheet_id}` on every sheet-scoped endpoint, and as `target_sheet_id` when another sheet routes data here via `send_to_sheet`.

namestringrequired

Sheet name as set at creation. Not required to be unique within a workflow.

is_main_sheetbooleanrequired

`true` for the workflow's main sheet — auto-created with the workflow, always present, and has `sheet_id === data.workflow_id`.

auto_runbooleanrequired

When `true` (default), the sheet's action chain runs automatically whenever new data rows arrive.

cache_enabledbooleanrequired

When `true` (default), a row with input column values identical to a previously-run row reuses the previous row's outputs instead of re-running the action chain.

cache_sincenull | string <date>required

Earliest date (`YYYY-MM-DD`, UTC) from which cached runs are considered fresh. `null` means all cached runs are considered fresh regardless of age.

webhook_urlnull | string <uri>required

POST URL for pushing rows into this sheet via webhook. Send a JSON body whose keys match the sheet's input columns. `null` when the sheet has no webhook input configured.

Example

WorkflowOverviewSheet example

{
  "sheet_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "is_main_sheet": false,
  "auto_run": false,
  "cache_enabled": false,
  "cache_since": null,
  "webhook_url": null
}