Choose a version:

flowTriggerReceive

mutation

Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to Create Shopify Flow triggers.

Arguments

Anchor to handlehandle • String: The handle of the trigger.
Anchor to payloadpayload • JSON: The payload needed to run the Trigger.
Anchor to bodybody • String: The payload needed to run the Trigger.

Was this section helpful?

Anchor to FlowTriggerReceivePayload returnsFlowTriggerReceivePayload returns

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

Was this section helpful?

Trigger workflows defined in Shopify Flow
flowTriggerReceive reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation flowTriggerReceive($handle: String, $payload: JSON) {

flowTriggerReceive(handle: $handle, payload: $payload) {

userErrors {

field

message

}

}`,

{

variables: {

"handle": "handle",

"payload": {

"key": "Some value"

}

);

const data = await response.json();

mutation flowTriggerReceive($handle: String, $payload: JSON) {
  flowTriggerReceive(handle: $handle, payload: $payload) {
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation flowTriggerReceive($handle: String, $payload: JSON) { flowTriggerReceive(handle: $handle, payload: $payload) { userErrors { field message } } }",
 "variables": {
    "handle": "handle",
    "payload": {
      "key": "Some value"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation flowTriggerReceive($handle: String, $payload: JSON) {
    flowTriggerReceive(handle: $handle, payload: $payload) {
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "handle": "handle",
      "payload": {
        "key": "Some value"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation flowTriggerReceive($handle: String, $payload: JSON) {
      flowTriggerReceive(handle: $handle, payload: $payload) {
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "handle": "handle",
      "payload": {
        "key": "Some value"
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation flowTriggerReceive($handle: String, $payload: JSON) {
    flowTriggerReceive(handle: $handle, payload: $payload) {
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "handle": "handle",
  "payload": {
    "key": "Some value"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"handle": "handle",

"payload": {

"key": "Some value"

}

Response

JSON

{

"flowTriggerReceive": {

"userErrors": []

}