Skip to main content
Anchor to AutomationWorkflowCreatePayload

AutomationWorkflowCreatePayload

payload

Return type for automationWorkflowCreate mutation.

Anchor to FieldsFields

Anchor to automationWorkflowautomationWorkflow
•AutomationWorkflow

The saved draft automation. Returns null if an error is raised.

Show fields
Anchor to userErrorsuserErrors
•[AutomationWorkflowUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields
Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

Anchor to automationWorkflowCreateautomationWorkflowCreate
•mutation

Creates a draft automation from a JSON configuration.

Input errors are returned in userErrors and nothing is saved. A saved draft can still have validationErrors for its configuration and activationErrors for non-structural blockers; resolve both before activating.

Show payload

Arguments

Anchor to configurationconfiguration
•JSON!
required

The JSON configuration used to create the automation, including __metadata.version set to 0.1 and root. Define its logic in root.steps, root.links, and root.patched_fields. Supply name, tags, and note as separate arguments; root.workflow_name, root.tags, and root.note are rejected. See the workflow configuration JSON Schema.

Anchor to namename
•String!
required

The automation name, shared by all versions. Null and blank names are rejected.

Anchor to notenote
•String

The note for the new draft, separate from configuration and step notes. Omit or use null to leave it unset.

Anchor to tagstags
•[String!]

The automation tags, shared by all versions. Omit or use null to create the automation with no tags.

Was this section helpful?