Workbench

Set Workbench Schedule

Run something on this table on a schedule. CAN ARM ONGOING SPEND.

action_type: run_ai means every firing runs the table's AI passes and charges for them - nightly, forever, with nobody in the loop. run_formula is local and free; crm_import reaches the customer's CRM.

enabled defaults to FALSE, so writing a schedule and starting it are two separate acts. That is deliberate: it lets a caller define the cadence, read it back, and only then turn it on.

put/workbench/tables/{table_id}/schedule

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/schedule
  • Auth: HTTP bearer

Path parameters

table_idstring required

Workbench table id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

action_type'run_ai' | 'run_formula' | 'crm_import' required
cron_expressionstring nullable
frequency'hourly' | 'daily' | 'weekly' nullable
action_configobject nullable
enabledboolean

Response

Successful Response

dataEnrichmentPayload required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

Changes

No recorded changes to this operation across all 2 revisions of this API.