PRODUCTS_CREATE/PRODUCTS_UPDATE webhook missing metafields

GraphQL Admin API Troubleshooting
1

Our app requires some metafield data that the app create in a custom namespace. After the recent update, the specified metafieldNamespace is no longer returned.

Can you please advice on how I can fix this without having to trigger another graphQl call?

This is the variable I use to create the webhookSubscription:

const topic = 
      {
        topic: "PRODUCTS_UPDATE",
        includeFields: ["id", "title", "updated_at", "variants"],
        metafieldNamespaces: ["msa"],
      },

const variables = {
        topic: topic.topic,
        webhookSubscription: {
          callbackUrl: `${process.env.SHOPIFY_APP_URL || process.env.APP_URL}/webhooks`,
          format: "JSON",
          includeFields: topic.includeFields,
          metafieldNamespaces: topic.metafieldNamespaces,
        },
      };

And returned about webhookSubscriptionCreate

{"webhookSubscriptionCreate":{"webhookSubscription":{"apiVersion":{"displayName":"2024-10"},"id":"gid://shopify/WebhookSubscription/<...>","topic":"PRODUCTS_UPDATE","format":"JSON","includeFields":["id","title","updated_at","variants"],"endpoint":{"__typename":"WebhookHttpEndpoint","callbackUrl":"https://<...>/webhooks"},"metafieldNamespaces":["msa"]}}}
1 Like
2

Hey @hmpws

I see what’s happening with your webhook not returning those metafields anymore. This is tied to our recent migration away from private metafields that affected how namespaces work.

It looks like you need to add the $app: prefix to your namespace in the webhook subscription. Change your metafieldNamespaces from ["msa"] to ["$app:msa"] and you should be good to go. This prefix is now required to identify app-owned metafields in your specified namespace.

Check out our migration guide for the full details: Migrate private metafields - there are some helpful before/after examples that show exactly what changed.

3

Thanks. So we will need to migrate the old data as well and inform our merchants to modify data differently if they want to keep using the app. I didn’t think the our metafield is a private metafield but now webhooks don’t return public metafield data, a bit of an unexpected change to be honest!