Our Partner & Developer boards on the community are moving to a brand new home: the .dev community forums! While you can still access past discussions here, for all your future app and storefront building questions, head over to the new forums.

What scopes are required to create a webhook for a given topic?

What scopes are required to create a webhook for a given topic?

ClementG
Shopify Partner
660 0 130

Given a webhook topic, how do I find out what scope is required to create a webhook on that topic?

Is this documented anywhere?

Replies 5 (5)

ClementG
Shopify Partner
660 0 130

I guess that's a no?

Josh_Brown1
Shopify Staff (Retired)
146 0 28

Hey Clement,

In general you will need the same OAuth scopes for the webhook as you would for the corresponding REST API. The OAuth scopes are documented here: https://help.shopify.com/api/guides/authentication/oauth#scopes

Any app can register the app/uninstall webhook.

To learn more visit the Shopify Help Center or the Community Blog.

ClementG
Shopify Partner
660 0 130

Right, but only read scopes are required, right?

For example, if I want to be notified whenever an order is created/updated, I wouldn't need the scope 'write_orders', would I? (since webhooks are only a read-only notifications)

Jamie_D_
Shopify Staff (Retired)
533 1 92

Hi Clement,

You are correct.

For example, if you wish to subscribe to products/update webhooks, you must have the read_orders scope.

To learn more visit the Shopify Help Center or the Community Blog.

ClementG
Shopify Partner
660 0 130

Great. Thanks!