Automation Task
Requires access scope. Also: The app must have write access to automations and act on behalf of a user.
A version of a task that can be used as a step in an automation.
Anchor to FieldsFields
- configFields ([AutomationTaskConfigField!]!)
- connector (AutomationConnector!)
- description (String)
- id (ID!)
- label (String!)
- outputPortIds ([String!]!)
- returnFields ([AutomationTaskReturnField!]!)
- state (AutomationTaskState!)
- taskId (String!)
- taskType (AutomationTaskType!)
- version (String!)
- Anchor to configFieldsconfig•[Automation
Fields Task Config Field!]! non-null The task configuration fields.
Show fields
- Anchor to connectorconnector•Automation
Connector! non-null The connector providing the task.
Show fields
- Anchor to descriptiondescription•String
The task description.
- •ID!non-null
A globally-unique ID.
- Anchor to labellabel•String!non-null
The task display name.
- Anchor to outputPortIdsoutput•[String!]!
Port Ids non-null The output port IDs used by links between automation steps.
- Anchor to returnFieldsreturn•[Automation
Fields Task Return Field!]! non-null The values returned by the task.
Show fields
- Anchor to statestate•Automation
Task State! non-null The publication state of this task version.
Show enum values
- Anchor to taskIdtask•String!
Id non-null The task ID written into an automation step. Use it with
versionto identify the task.- Anchor to taskTypetask•Automation
Type Task Type! non-null The role the task plays in an automation.
Show enum values
- Anchor to versionversion•String!non-null
The task version written into an automation step.
Anchor to QueriesQueries
- automationTask (AutomationTask)
- automationTasks (AutomationTaskConnection!)
- •query
Returns an automation task by ID.
Show fields
- •ID!required
The ID of the automation task to return.
Arguments
- •ID!
- •query
Returns the automation tasks available to the shop.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A free-text search over task labels and descriptions.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to taskTypetask•Automation
Type Task Type Restricts results to one task type.
Show enum values
Arguments