Anchor to section titled 'undefined'flow
flow
mutation
2024-04
Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to Create Shopify Flow triggers.
Anchor to section titled 'Arguments'
Arguments
- Anchor to handlehandle
The handle of the trigger.
- Anchor to payloadpayload
The payload needed to run the Trigger.
Was this section helpful?
Anchor to section titled 'FlowTriggerReceivePayload returns'
FlowTriggerReceivePayload returns
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: flowTriggerReceive
Query Reference for MUTATION: flowTriggerReceive
"mutation flowTriggerReceive {\n flowTriggerReceive {\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: flowTriggerReceive
"{\n \"body\": \"<your-body>\",\n \"handle\": \"<your-handle>\",\n \"payload\": \"{ \\\"name\\\": \\\"Size\\\", \\\"values\\\": [\\\"M\\\", \\\"L\\\"] }\"\n}"Schema Reference for MUTATION: flowTriggerReceive
""
Display Examples for MUTATION: flowTriggerReceive
[
{
"example": {
"type_name": "flowtriggerreceive",
"title": "Trigger workflows defined in Shopify Flow",
"description": "Triggers any workflow that uses the trigger specified in the payload.",
"query_string": "mutation flowTriggerReceive($handle: String, $payload: JSON) {\n flowTriggerReceive(handle: $handle, payload: $payload) {\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"handle": "handle",
"payload": {
"key": "Some value"
}
},
"response": {
"data": {
"flowTriggerReceive": {
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/flow_trigger_receive_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation flowTriggerReceive($handle: String, $payload: JSON) { flowTriggerReceive(handle: $handle, payload: $payload) { userErrors { field message } } }\",\n \"variables\": {\n \"handle\": \"handle\",\n \"payload\": {\n \"key\": \"Some value\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation flowTriggerReceive($handle: String, $payload: JSON) {\n flowTriggerReceive(handle: $handle, payload: $payload) {\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"handle\": \"handle\",\n \"payload\": {\n \"key\": \"Some value\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation flowTriggerReceive($handle: String, $payload: JSON) {\n flowTriggerReceive(handle: $handle, payload: $payload) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"handle\": \"handle\",\n \"payload\": {\n \"key\": \"Some value\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation flowTriggerReceive($handle: String, $payload: JSON) {\n flowTriggerReceive(handle: $handle, payload: $payload) {\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"handle\": \"handle\",\n \"payload\": {\n \"key\": \"Some value\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation flowTriggerReceive($handle: String, $payload: JSON) {\n flowTriggerReceive(handle: $handle, payload: $payload) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"handle\" => \"handle\",\n \"payload\" => [\n \"key\" => \"Some value\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "handle",
"description": "The handle of the trigger.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "String",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "handle",
"argValue": " \"handle\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "payload",
"description": "The payload needed to run the Trigger.",
"type": {
"kind": "SCALAR",
"name": "JSON",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "JSON",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "payload",
"argValue": " {\"key\":\"Some value\"}",
"typeKind": "MUTATION"
}
]
}
]