automationWorkflowTestRunStart

mutation

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

Starts one test run of the latest automation version, the latest draft or otherwise the main version, with one saved test event. Steps with side effects are stubbed, and the test event selected in the automation editor doesn't change. The returned run is accepted, not completed: read the run by its ID for the outcome.

Anchor to Arguments

Arguments

Anchor to testEventIdtestEventId •ID! required: The ID of one of the automation's saved test events. The run uses its trigger data.
Anchor to versionversion •String! required: The version the caller expects to be the latest. If it isn't, no run starts. It isn't a way to test an earlier version.
Anchor to workflowIdworkflowId •ID! required: The ID of the automation to test.

Was this section helpful?

Anchor to AutomationWorkflowTestRunStartPayload returnsAutomationWorkflowTestRunStartPayload returns

Anchor to automationWorkflowRunIdautomationWorkflowRunId •ID: The ID of the accepted test run. Returns null if the test run didn't start.
Anchor to userErrorsuserErrors •[AutomationWorkflowTestRunStartUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

automationWorkflowTestRunStart reference

Mutation Reference

mutation automationWorkflowTestRunStart($testEventId: ID!, $version: String!, $workflowId: ID!) {

automationWorkflowTestRunStart(testEventId: $testEventId, version: $version, workflowId: $workflowId) {

automationWorkflowRunId

userErrors {

field

message

}

Input

{

"testEventId": "gid://shopify/AutomationTestEvent/10079785100",

"version": "<your-version>",

"workflowId": "gid://shopify/AutomationWorkflow/10079785100"

}