Flow trigger return data description not showing up

Shopify Flow
1

Hello,

We have created a flow trigger that is working correctly with one slight problem.

In the Shopify Flow UI, when trying ‘Add a variable’ for actions. The description for the returned variable is not showing up, e.g. the ‘change’ variable from screenshot in this case. It would be very helpful for our users to see the description. I have also attached the corresponding toml. Hopefully this isn’t a user error on our part.

Thanks.

image
image701×234 8.35 KB

image
image667×247 4.69 KB

1 Like
2

Hi there,

Instead of putting the description as a field in the TOML file, you can put the description as a comment above the type declaration in the schema.graphql file. For example:

"Represents some kind of change"
type Change {
  key: String!
  value: String!
}

Then it will show in Flow as expected

image
image1278×658 42.8 KB

Thanks!

Ryan

1 Like
4

Thank you for the prompt reply! It worked correctly!

I double checked that this isn’t documented in the Flow trigger reference. Hopefully others find this helpful.

image
image892×546 55.9 KB