Note: This question is not about how to retrieve the list of webhook topics an app is subscribed to.
Shopify API Version: 2022-01 (Latest)
Shopify Admin Api: REST Admin Api
The Shopify Webhook Documentation lists several webhook topics by category.
Example:
Subscription Error
Most all of the topics listed in the documentation can be subscribed to. However, if I try to subscribe to any of the BillingAttempt topics, Shopify returns an error:
Invalid topic specified: subscription_billing_attemptssuccess.
Does it exist? Is there a missing access scope?
This particular webhook is for a custom app installed directly in the store. I have verified every available access scope has been enabled. As of today, there are a total of 62 available scopes and all are enabled.
What is the Actual Question?
This isn’t about troubleshooting the above error.
The question is specifically: Where can I find the complete list of available topics?
Note: Shopify includes a full list of topics in their error message. But, none of them are for subscription_billing_xxx topics. Maybe this is just a case where the API error has the most update to date list? And the docs are out of date?
2
Answers
If I understood correctly this topics list is the one you are searching for: https://shopify.dev/api/admin-graphql/2023-01/enums/WebhookSubscriptionTopic
There is SUBSCRIPTION_BILLING_xxx topics:
For the REST API: https://shopify.dev/api/admin-rest/2023-01/resources/webhook#event-topics
For the GraphQL API: https://shopify.dev/api/admin-graphql/2023-01/enums/WebhookSubscriptionTopic