sincecutoff.com
/v1/json /v1/md llms.txt
← all changes

shopify.app.toml webhook subscriptions accept an optional name

Introduced 2026-01-20 · score 0.94

HOW TO USE IT

When configuring a webhook subscription in `shopify.app.toml`, add a non-empty `name` to label it; then run `shopify app deploy` to deploy the configuration. [Webhook docs](https://shopify.dev/docs/apps/build/webhooks/subscribe)

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

WHY THIS HELPS

Configure a webhook subscription with a name in an app's `shopify.app.toml`.

REQUIREMENTS AND LIMITATIONS

  • Version: 3.89.0
  • name: Subscription label; Shopify echoes it in the `X-Shopify-Name` header. The current docs specify alphanumeric characters, hyphens, or underscores, up to 50 characters.
  • topics (required): One or more webhook topic names to subscribe to.
  • uri (required): Delivery destination: HTTPS URL, AWS EventBridge ARN, or Google Pub/Sub URI.
  • Prerequisite: Each subscribed topic requires its corresponding access scope.
  • The `name` field is optional and must be a non-empty string if provided.
  • Docs conflict: The current docs limit `name` to 50 characters and allow only alphanumeric characters, hyphens, and underscores; the 3.89.0 release note only specifies a non-empty string. These added constraints are documented for a later/current version and are not applied here.

FIRST-PARTY EVIDENCE

Check the installed version and the source before using it. Entry JSON

Report a problem with this card