Add clear reference to webhook scopes documentation in overview #1062
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #998
The webhook overview page shows how to create a webhook with a
scope
property (e.g.,"scope": "store/order/updated"
) but didn't provide an obvious way for users to discover all available webhook scopes.This PR adds a prominent callout immediately after the webhook creation example that directs users to the comprehensive Webhook Events reference where all available scopes are documented.
Before: Users had to scroll through the entire overview page to find references to the webhook events page, and it wasn't clear that's where scopes are documented.
After: Users see a clear, contextual callout right after the webhook creation example that specifically mentions the
scope
property and points them to the right documentation.The change is minimal (3 lines) and follows existing documentation patterns with an info callout that provides helpful guidance exactly when users need it.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.