Repository navigation
Add typed JSON output to app webhook trigger - #8817
isaacroldan wants to merge 6 commits into
Conversation
|
/snapit |
|
🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm. Built from Test the snapshot by installing your package globally: pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007115641Caution After installing, validate the version by running |
4f0d976 to
bb32942
Compare
|
/snapit |
|
🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm. Built from Test the snapshot by installing your package globally: pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007133855Caution After installing, validate the version by running |
|
/snapit |
|
🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm. Built from Test the snapshot by installing your package globally: pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007140407Caution After installing, validate the version by running |
d758339 to
6387532
Compare
|
/snapit |
|
🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm. Built from Test the snapshot by installing your package globally: pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261009084819Caution After installing, validate the version by running |
|
/snapit |
|
🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm. Built from Test the snapshot by installing your package globally: pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261009104727Caution After installing, validate the version by running |
WHY are these changes introduced?
Let scripts read webhook delivery results. Related to #23671.
WHAT is this pull request doing?
Add
--jsonwith the topic, API version, delivery method, address, and delivery status. Remote delivery reportsenqueued; localhost delivery reportsdeliveredafter a successful HTTP response. JSON request and local delivery failures use the shared error document. Preserve text output and mask signing secrets in request diagnostics.Text:
Webhook has been enqueued for delivery.JSON:
{"status":"success","delivery":{"topic":"orders/create","apiVersion":"2026-10","deliveryMethod":"http","address":"https://example.com/webhooks","status":"enqueued"}}.How to manually test your changes?
Use a linked test app and a local webhook handler.
shopify app webhook trigger --topic orders/create --api-version <api-version> --address http://localhost:3000/webhooks --json > result.json. Check that the handler receives the sample and stdout has one result withdelivery.statusset todelivered.--jsonto compare the existing warning.shopify app webhook trigger --json-schemato inspect the delivery contract. Use an HTTPS address to check the remoteenqueuedresult.Checklist