Webhook payloads are not sufficiently documented

Shopify Apps
1

Curently, webhook payload documentation is solely a single response sample. This is not enough

to keep a well maintained app. Other places where I searched (online posts, official library repositories,

this forum, and other docs), either don’t have information or have questions unsolved:

https://community.shopify.com/post/2081023

https://github.com/Shopify/shopify-api-js/issues/359

Relying on a single sample to infer types is time-consuming, error-prone, inconvenient, hard (as other

alternative values can’t be seen). In addition to this, sample mentions resources, but the responses

include extra fields. Take the product webhook for instance.

Finally, a last problem that I found is that the AI assistant at https://shopify.dev/docs/ provide incorrect

answers regarding these types.

I would like to know if there are plans for publishing (as they must have been implemented prior to releasing

the webhooks to the public, necessarily) them.

Thanks

2

Even more, the app_subscription/update webhook does not always retrieve all the data shown in the documentation.

It is very important to have such cases documented.

Also, the sample responses show null values that do not allow to get the value type.