Skip to main content
object

Requires write_automations 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.

•[AutomationTaskConfigField!]!
non-null

The task configuration fields.

Show fields
•AutomationConnector!
non-null

The connector providing the task.

Show fields
•String

The task description.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The task display name.

•[String!]!
non-null

The output port IDs used by links between automation steps.

•[AutomationTaskReturnField!]!
non-null

The values returned by the task.

Show fields
•AutomationTaskState!
non-null

The publication state of this task version.

Show enum values
•String!
non-null

The task ID written into an automation step. Use it with version to identify the task.

•AutomationTaskType!
non-null

The role the task plays in an automation.

Show enum values
•String!
non-null

The task version written into an automation step.


Was this section helpful?

•query

Returns an automation task by ID.

Show fields

Arguments

•ID!
required

The ID of the automation task to return.


•query

Returns the automation tasks available to the shop.

Show fields

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A free-text search over task labels and descriptions.

•Boolean
Default:false

Reverse the order of the underlying list.

•AutomationTaskType

Restricts results to one task type.

Show enum values


Was this section helpful?

•interface

Was this section helpful?