Skip to main content
QUERY
workflow(workflowId: ID!): Workflow

Arguments

workflowId
ID!
required

Returns

id
ID!
name
String!
trigger
String!

JSON-encoded trigger configuration, shaped as { "type": <triggerType>, ... }. Valid types and their required fields:

  • manual — no extra fields; the workflow runs only via the triggerWorkflow mutation or a UI button.
  • eventsevents: 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.
  • schedulecron: string; runs on a recurring cron schedule evaluated in UTC. Example: {"type":"events","events":["thread.thread_field_updated"]}.
startStepId
ID

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.

steps

The steps in this workflow.

publishedAt

Timestamp when the workflow was last published. Null means the workflow is an inactive draft.

order
Int!

Display order of this workflow relative to other workflows. Lower values appear first.

sourceTemplateId
ID

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.

createdAt
createdBy
updatedAt
updatedBy
Query
Variables
Response