Workflow
WorkflowFields
JSON-encoded trigger configuration, shaped as { "type": <triggerType>, ... }. Valid types and their required fields:
manual— no extra fields; the workflow runs only via thetriggerWorkflowmutation or a UI button.events—events: string[](at least one); runs on the listed domain events, e.g.thread.thread_created,thread.message_added,thread.thread_field_updated,thread.thread_labels_changed,thread.thread_status_transitioned.schedule—cron: string; runs on a recurring cron schedule evaluated in UTC. Example:{"type":"events","events":["thread.thread_field_updated"]}.
The ID of the first step to execute, or null if the workflow has no steps. This cannot be cleared to null on a published workflow (Cannot clear startStepId on a published workflow); to restructure a published workflow's steps, unpublish it first (updateWorkflow with isPublished: false), restructure, then republish.
The steps in this workflow.
Timestamp when the workflow was last published. Null means the workflow is an inactive draft.
Opaque sort key. Compare lexicographically to order workflows within a workspace — the
connection is already returned in this order. Sorting locally cannot disagree with the server:
the encoding is ASCII-only (0-9A-Za-z), so JavaScript's < matches the database's byte
ordering. Do not construct, parse or persist it: the encoding may change. To reorder, use
moveWorkflow, which takes IDs.
1-based dispatch priority among published event workflows with a start step, derived from
position, so moveWorkflow changes it. A lower number is always considered first, though
only the workflows listening for the arriving event run. 0 for anything outside that set.
When this workflow was most recently triggered, or null if it never has been. Dates the trigger rather than the outcome, so a queued or failed run sets it as a successful one does.
The gallery template this workflow was created from, if any. Provenance only: the template may since have changed or been retired, and the workflow diverges as soon as it is edited.
Was this page helpful?

