Shopify / Shopify/shopify-app-template-php

No guidance on setting up and using webhooks with shopify-app-template-php

Open
#485 1 comment 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
340
Forks
108
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-template-php. There is no clear documentation I can find about how to do this.

However, the template has already done a lot of this for us.
How am I supposed to register a Webhook for example orders/create without overriding the boilerplate that Shopify has provided in this template?

What is the correct way to process them after this? Where is the /api/webhooks endpoint that the boilerplate code sets being used? I can't find it in the template.

This is extremely unclear what the pattern should be for using Webhooks with this template without overriding the boilerplate 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?

Note:
I am developing a custom app that requires me to perform a certain task on when an event occurs in the store.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the template's /api/webhooks endpoint and the existing webhook boilerplate. Document how to register an orders/create webhook, how requests are processed, and how custom app behavior fits without overriding the provided code. Done means a newcomer can follow the documented pattern to configure and handle a webhook.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.