Choose a version:

automationWorkflowCreate

mutation

Requires write_automations access scope. Also: The app must have write access to automations and act on behalf of a user.

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, such as a missing action or an incomplete configuration field; fix those before activating.

Anchor to Arguments

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?

Anchor to AutomationWorkflowCreatePayload returnsAutomationWorkflowCreatePayload returns

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?

Examples

automationWorkflowCreate reference

Mutation Reference

mutation automationWorkflowCreate($configuration: JSON!, $name: String!, $note: String, $tags: [String!]) {

automationWorkflowCreate(configuration: $configuration, name: $name, note: $note, tags: $tags) {

automationWorkflow {

# AutomationWorkflow fields

}

userErrors {

field

message

}

Input

{

"configuration": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }",

"name": "<your-name>",

"note": "<your-note>",

"tags": [

"<your-tags>"

]

}