flowTriggerReceive mutation

Triggers a workflow defined by the merchant in Shopify Flow. To learn more, see Create Shopify Flow triggers.

On this page

Interactive example

This is an example mutation query.

mutation flowTriggerReceive($body: String!) { flowTriggerReceive(body: $body) { 
  1. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">field</font>
  5.   <font style="color:#1F61A0;">message</font>
  7. <font style="color:#555555;">}</font>
} } { “body”: “placeholder” }

Arguments

Argument Description
body
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The payload needed to run the Trigger.

Return fields

  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.