Automation
Requires access scope.
An error that prevented an automation operation from succeeding. For create and
update, the requested changes weren't saved. Check code for the reason and
field for the affected argument when available. Validation errors on a saved
version are returned in .
Anchor to FieldsFields
- code (AutomationWorkflowUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Automation
Workflow User Error Code The error code.
Show enum values
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- automationWorkflowActivate (AutomationWorkflowActivatePayload)
- automationWorkflowCreate (AutomationWorkflowCreatePayload)
- automationWorkflowDeactivate (AutomationWorkflowDeactivatePayload)
- automationWorkflowDelete (AutomationWorkflowDeletePayload)
- automationWorkflowUpdate (AutomationWorkflowUpdatePayload)
- •mutation
Activates a specific automation version. Activating the currently active version succeeds without making changes, even when a newer draft exists.
Show payload
- •ID!required
The ID of the automation to activate.
- Anchor to versionversion•String!required
The version to activate. Must be the latest draft or the most recently published version. Activating the published version keeps any newer draft.
Arguments
- •ID!
- •mutation
Creates a draft automation from a JSON configuration.
Input errors are returned in
and nothing is saved. A saved draft can still have, such as a missing action or an incomplete configuration field; fix those before activating.Show payload
- Anchor to configurationconfiguration•JSON!required
The JSON configuration used to create the automation, including
__metadata.versionset to0.1androot. Define its logic inroot.steps,root.links, and. Supply name, tags, and note as separate arguments;,root.tags, androot.noteare 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.
- •[String!]
The automation tags, shared by all versions. Omit or use null to create the automation with no tags.
Arguments
- •mutation
Deactivates a specific automation version and cancels its runs. An action already executing may still finish.
Show payload
- •ID!required
The ID of the automation to deactivate.
- Anchor to versionversion•String!required
The version to deactivate. Deactivating an inactive version succeeds without making changes.
Arguments
- •ID!
- •mutation
Deletes an inactive automation. Deactivate an active automation before deleting it.
Show payload
- •ID!required
The ID of the automation to delete.
Arguments
- •ID!
- •mutation
Updates an automation's name, tags, note, or configuration. Supply at least one editable field. Omitted fields keep their existing values.
Replacing the configuration edits the latest draft in place, or creates a draft if none exists. Any active version continues running with its existing configuration. Changes to the name, tags, or note don't create a draft.
Input errors are returned in
and nothing is saved. A saved version can still have; fix those before activating it.Show payload
- Anchor to configurationconfiguration•JSON
The full replacement JSON configuration, including
__metadata.versionandroot. Replaces the steps, links, and custom fields (). Supply name, tags, and note as separate arguments;,root.tags, androot.noteare rejected. Omit to leave the configuration unchanged. Null is rejected. See the workflow configuration JSON Schema.- •ID!required
The ID of the automation to update.
- Anchor to namename•String
The new automation name, shared by all versions. Omit to leave it unchanged. Null and blank names are rejected.
- Anchor to notenote•String
The note for the version being updated. Omit to leave it unchanged; use null to clear it.
- •[String!]
The replacement tags, shared by all versions. Omit or use null to leave them unchanged; use an empty list to clear them.
- Anchor to versionversion•String!required
The version this edit is based on. Use the latest draft, or the most recently published version when no draft exists. A different version returns
OUTDATED_WORKFLOW. Edits within the same draft and changes to name, tags, or note keep this identifier, so the check can't detect those edits.
Arguments