added a name field to webhook subscriptions #6576

georgge293 · 2025-11-05T16:39:05Z

closes https://github.com/shop/issues-event-foundations/issues/518

WHY are these changes introduced?

Adds support for the name field on webhook subscriptions when registered in the app's shopify.app.toml

WHAT is this pull request doing?

Adds optional name field to webhook subscription TypeScript types
Adds validation for the name field in webhook subscription schemas (must be a non-empty string if provided)
Adds test coverage for webhook subscriptions with the name attribute

Name validation:

Field is optional
Must be a non-empty string if provided

How to test your changes

Create a webhook subscription in your shopify.app.toml with a name field while running local app development in dev dash:

Example:

[[webhooks.subscriptions]]
name = "products-create"
topics = ["products/create"]
uri = "https://example.com/webhooks"

Run shopify app deploy and verify it accepts the configuration
Try with an empty name = "" and verify validation rejects it
Run the test suite: pnpm vitest loader.test.ts --run

Tophat:

Tophatted changes locally verifying that the min and max char validations are working

github-actions · 2025-11-05T17:06:40Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	79.51% (+0.28% 🔼)	14177/17830
🟡	Branches	73.57% (+0.46% 🔼)	6952/9450
🟡	Functions	79.68% (+0.31% 🔼)	3639/4567
🟡	Lines	79.88% (+0.3% 🔼)	13401/16777

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / admin-as-app.ts	100%	100%	100%	100%
🟢	`...` / metafield_definitions.ts	100%	100%	100%	100%
🟢	`...` / metaobject_definitions.ts	100%	100%	100%	100%
🟢	`...` / bulk-operation-run-mutation.ts	100%	100%	100%	100%
🟢	`...` / bulk-operation-run-query.ts	100%	100%	100%	100%
🟢	`...` / get-bulk-operation-by-id.ts	100%	100%	100%	100%
🟢	`...` / list-bulk-operations.ts	100%	100%	100%	100%
🟢	`...` / staged-uploads-create.ts	100%	100%	100%	100%
🔴	`...` / execute.ts	0%	0%	0%	0%
🔴	`...` / status.ts	0%	0%	0%	0%
🔴	`...` / pull.ts	0%	100%	0%	0%
🟢	`...` / execute-operation.ts	92.59%	75%	100%	92.31%
🔴	`...` / pull.ts	0%	0%	0%	0%
🟢	`...` / bulk-operation-status.ts	96.55%	92.11%	100%	100%
🟢	`...` / constants.ts	100%	100%	100%	100%
🟢	`...` / download-bulk-operation-results.ts	100%	100%	100%	100%
🟢	`...` / execute-bulk-operation.ts	92.65%	86.67%	100%	93.94%
🟢	`...` / format-bulk-operation-status.ts	100%	100%	100%	100%
🟢	`...` / run-mutation.ts	100%	100%	100%	100%
🟢	`...` / run-query.ts	100%	100%	100%	100%
🟡	`...` / stage-file.ts	73.53%	62.5%	85.71%	72.73%
🟢	`...` / watch-bulk-operation.ts	100%	94.74%	100%	100%
🟢	`...` / declarative-definitions.ts	98.54%	93.18%	100%	98.51%
🟢	`...` / common.ts	97.22%	93.75%	100%	96.55%
🟢	`...` / execute-command-helpers.ts	100%	100%	100%	100%
🔴	`...` / promiseWithResolvers.ts	33.33%	50%	50%	33.33%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🔴	`...` / execute.ts	0%	0% (-100% 🔻)	0%	0%
🟢	`...` / extension-instance.ts	84.8% (+0.23% 🔼)	77.6% (-0.91% 🔻)	92.06% (+0.13% 🔼)	85.11% (+0.24% 🔼)
🟡	`...` / specification.ts	69.09%	75.61% (+2.44% 🔼)	76.47% (-1.31% 🔻)	68.75%
🟢	`...` / ui_extension.ts	85.38% (-9.44% 🔻)	72.34% (-8.91% 🔻)	84% (-16% 🔻)	88% (-8.46% 🔻)
🟢	`...` / developer-platform-client.ts	84.62% (-1.5% 🔻)	71.43% (+0.84% 🔼)	81.82% (+1.82% 🔼)	93.75% (+0.42% 🔼)
🟢	`...` / api.ts	87.07% (-0.43% 🔻)	76.71% (-0.1% 🔻)	100%	86.49% (-0.43% 🔻)
🟢	`...` / SingleTask.tsx	84.21% (-15.79% 🔻)	50% (-50% 🔻)	80% (-20% 🔻)	84.21% (-15.79% 🔻)
🔴	`...` / environment.ts	35% (-5% 🔻)	41.18%	40% (-10% 🔻)	36.84% (-5.26% 🔻)
🔴	`...` / ui.tsx	50.82% (-0.79% 🔻)	42.86% (-5.53% 🔻)	54.55% (+1.42% 🔼)	50% (-0.82% 🔻)
🟢	`...` / console.ts	81.82% (+15.15% 🔼)	75% (-25% 🔻)	100% (+33.33% 🔼)	81.82% (+15.15% 🔼)
🔴	`...` / dev.ts	14.29% (+0.95% 🔼)	3.13% (+0.18% 🔼)	50% (-7.14% 🔻)	14.29% (+0.95% 🔼)
🟢	`...` / init.ts	88% (-0.89% 🔻)	71.43% (+4.76% 🔼)	86.67% (+4.85% 🔼)	88% (-0.89% 🔻)
🟢	`...` / storefront-renderer.ts	90.2% (-0.54% 🔻)	78.95%	81.82% (-1.52% 🔻)	90.2% (-0.54% 🔻)
🟡	`...` / theme-polling.ts	67.12% (-0.93% 🔻)	68.75%	78.57%	66.67% (-0.98% 🔻)

Test suite run success

3554 tests passing in 1415 suites.

Report generated by 🧪jest coverage report action from 833d751

georgge293 · 2025-11-05T19:34:49Z

I have signed the CLA!

georgge293 · 2025-11-05T21:39:06Z

Note: Shopify core changes must be deployed first before the CLI or adding the name field would fail to be recognized and error

...i/models/extensions/specifications/app_config_webhook_schemas/webhook_subscription_schema.ts

plvaldes · 2025-11-06T14:54:10Z

Note: Shopify core changes must be deployed first before the CLI or adding the name field would fail to be recognized and error

@georgge293 This PR is already approved but the core changes won't be deployed until after BFCM. I see some chances this PR is still accidentally merged. Which might be fine because afaik there won't be more CLI releases before BFCM, but core pending deploys could take a few days to deploy after BFCM and we should be careful to not release the CLI until that specific PR is deployed if we don't want to release a broken feature.

I may be a bit paranoid here, but what about moving this PR back to draft? You would keep the approvals and prevent an accidental merge from someone who hasn't read your comment on the core changes dependency

georgge293 · 2025-11-06T18:48:23Z

Note: Shopify core changes must be deployed first before the CLI or adding the name field would fail to be recognized and error

@georgge293 This PR is already approved but the core changes won't be deployed until after BFCM. I see some chances this PR is still accidentally merged. Which might be fine because afaik there won't be more CLI releases before BFCM, but core pending deploys could take a few days to deploy after BFCM and we should be careful to not release the CLI until that specific PR is deployed if we don't want to release a broken feature.

I may be a bit paranoid here, but what about moving this PR back to draft? You would keep the approvals and prevent an accidental merge from someone who hasn't read your comment on the core changes dependency

Sounds good, will do. Thanks!

georgge293 requested a review from a team as a code owner November 5, 2025 16:39

This comment has been minimized.

Sign in to view

github-actions bot added the cla-needed label Nov 5, 2025

georgge293 requested a review from a team as a code owner November 5, 2025 17:00

georgge293 force-pushed the add-webhook-name-field branch from ad0e53b to 88db281 Compare November 5, 2025 19:31

georgge293 force-pushed the add-webhook-name-field branch 2 times, most recently from 2c76c59 to e6e5eb6 Compare November 5, 2025 20:23

github-actions bot removed the cla-needed label Nov 5, 2025

odacrem approved these changes Nov 6, 2025

View reviewed changes

isaacroldan reviewed Nov 6, 2025

View reviewed changes

...i/models/extensions/specifications/app_config_webhook_schemas/webhook_subscription_schema.ts Outdated Show resolved Hide resolved

pacocastrotech approved these changes Nov 6, 2025

View reviewed changes

georgge293 marked this pull request as draft November 6, 2025 18:48

georgge293 self-assigned this Nov 19, 2025

georgge293 marked this pull request as ready for review December 9, 2025 14:32

georgge293 requested a review from isaacroldan December 9, 2025 15:23

pt2pham requested review from gonzaloriestra and removed request for isaacroldan December 9, 2025 22:15

gonzaloriestra approved these changes Dec 12, 2025

View reviewed changes

georgge293 added 4 commits December 15, 2025 10:36

added a name field to webhook subscriptions

84ae80a

Added changes to the next release CHANGELOG

437aedf

added max char validation

e39dbb6

added trim() to name field

833d751

georgge293 force-pushed the add-webhook-name-field branch from fc13dbb to 833d751 Compare December 15, 2025 15:37

georgge293 added this pull request to the merge queue Dec 15, 2025

Merged via the queue into main with commit 8f9a503 Dec 15, 2025
25 checks passed

georgge293 deleted the add-webhook-name-field branch December 15, 2025 16:12

gonzaloriestra mentioned this pull request Dec 16, 2025

added trim to the name field #6727

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

added a name field to webhook subscriptions #6576

added a name field to webhook subscriptions #6576

Uh oh!

georgge293 commented Nov 5, 2025 •

edited

Loading

Uh oh!

This comment has been minimized.

github-actions bot commented Nov 5, 2025 •

edited

Loading

Uh oh!

georgge293 commented Nov 5, 2025

Uh oh!

georgge293 commented Nov 5, 2025

Uh oh!

Uh oh!

plvaldes commented Nov 6, 2025

Uh oh!

georgge293 commented Nov 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

added a name field to webhook subscriptions #6576

added a name field to webhook subscriptions #6576

Uh oh!

Conversation

georgge293 commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes

Uh oh!

This comment has been minimized.

github-actions bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Test suite run success

Uh oh!

georgge293 commented Nov 5, 2025

Uh oh!

georgge293 commented Nov 5, 2025

Uh oh!

Uh oh!

plvaldes commented Nov 6, 2025

Uh oh!

georgge293 commented Nov 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

georgge293 commented Nov 5, 2025 •

edited

Loading

github-actions bot commented Nov 5, 2025 •

edited

Loading