flowTriggerReceive - admin-graphql - MUTATION

Version: 2024-04

Description:

Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers).

Access Scopes

Arguments

• body: String - The payload needed to run the Trigger.
• handle: String - The handle of the trigger.
• payload: JSON - The payload needed to run the Trigger.

Returns

• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Trigger workflows defined in Shopify Flow

          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"
          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"
          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"
          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"
          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"
          Graphql query: "mutation flowTriggerReceive($handle: String, $payload: JSON) {\n  flowTriggerReceive(handle: $handle, payload: $payload) {\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "handle": "handle",
    "payload": {
      "key": "Some value"
    }
  }

  response: {
    "data": {
      "flowTriggerReceive": {
        "userErrors": []
      }
    }
  }