Shopify / Shopify/shopify-app-template-node
No guidance on setting up and using webhooks with `shopify-app-node-template`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1k
- Forks
- 434
- PR merge metrics
- No merged PRs in 30d
Description
Issue summary
I am attempting to set up Webhooks in a shopify app generated by the shopify-app-node-template. There is no clear documentation I can find about how to do this, apart from the docs for shopify-api-js.
However, the template has already done a lot of this for us, but it is hidden amongst unreadable node-module packages. How am I supposed to register a Webhook after the OAuth callback without overriding the boiler plate that Shopify has included in this template?
What is the correct way to process them after this? Where is the /api/webhooks endpoint that the boiler plate code sets being used? I can't find it in the template.
This is straight forward in the docs for shopify-api-js, however this is utterly and extremely unclear what the pattern should be for using using Webhooks with this template without overriding the boiler plate code, and there are no docs I can find specifically to guide me.
Can anyone please help point me to the correct docs for how to set up and use Webhooks within this template?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the shopify-app-node-template OAuth callback and the /api/webhooks endpoint, then compare their behavior with the linked shopify-api-js webhook documentation. Document how webhook registration fits into the generated template and how incoming webhooks are processed; done means a newcomer can follow the documented pattern without replacing the boilerplate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100