Choose a version:

automationTestEventsCreate

mutation

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

Creates custom test events for an automation. If any event is invalid, or the events would exceed the automation's custom test event limit, none of them are created.

Anchor to Arguments

Arguments

Anchor to eventsevents

•[AutomationTestEventInput!]!

required

The custom test events to create.

Show input fields

Anchor to workflowIdworkflowId

•ID!

required

The ID of the automation to create the test events for.

Was this section helpful?

Anchor to AutomationTestEventsCreatePayload returnsAutomationTestEventsCreatePayload returns

Anchor to testEventstestEvents •[AutomationTestEvent!]: The created test events, in the order they were supplied. Returns null if the test events couldn't be created.

Show fields
Anchor to userErrorsuserErrors •[AutomationTestEventsCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

automationTestEventsCreate reference

Mutation Reference

mutation automationTestEventsCreate($events: [AutomationTestEventInput!]!, $workflowId: ID!) {

automationTestEventsCreate(events: $events, workflowId: $workflowId) {

testEvents {

# AutomationTestEvent fields

}

userErrors {

field

message

}

Input

{

"events": [

{

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

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

}

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

}

Variables

{
  "events": [
    {
      "name": "<your-name>",
      "triggerParams": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"
    }
  ],
  "workflowId": "gid://shopify/AutomationWorkflow/10079785100"
}

Schema

input AutomationTestEventInput {
  name: String!
  triggerParams: JSON!
}