Types > Workflow
Commerce APITypesWorkflow
Workflow

Description

Topic: Workflows

Fields

api_key: Key

API Key to use for API calls

Expandable

Permission bit: "keys.read"


description: String!

Description of the workflow


enabled: Boolean!

Whether this workflow is enabled or not

Example: true


id: String!

Unique workflow identifier. See also: Unique Identifiers

Example: "wf_EQzGqWoY"


name: String!

Name of the workflow

Example: "Tag orders"


next_at: String

The date and time when workflow will be triggered next (only cron triggers, +- 1 hour)

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


script: String!

A script to execute for the workflow (JavaScript)


timeout_violations: Int!

How many times this workflow violated execution timeout

Example: 1


trigger: String!

A trigger

Example: "product.created"


Used By

Mutations

workflowsCreate, workflowsModify

Queries

workflows

Preview (typescript)

Loading module