Webhooks are not being registered

[jagthedrummer]

Issue summary

Before opening this issue, I have:

• Upgraded to the latest version of the package
  • shopify_app version: 22.5.1
  • Ruby version: 3.4.1
  • Operating system: MacOS & Linux
• Set log_level: :debug in my configuration, if applicable
• Found a reliable way to reproduce the problem that indicates it's a problem with the package
• Looked for similar issues in this repository
• Checked that this isn't an issue with a Shopify API
  • If it is, please create a post in the Shopify community forums or report it to Shopify Partner Support

Webhooks that I've configured in config/initializers/shopify_app.rb are not being registered.

I have a block like this:

  config.webhooks = [
    {topic: 'app/uninstalled', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/app_uninstalled", format: 'json'},
    {topic: 'customers/data_request', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/customers_data_request", format: 'json'},
    {topic: 'customers/redact', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/customers_redact", format: 'json'},
    {topic: 'orders/create', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/orders_create", format: 'json'},
    {topic: 'shop/redact', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/shop_redact", format: 'json'},
    {topic: 'shop/update', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/shop_updated", format: 'json'},
    {topic: 'themes/update', address: "#{ENV['SHOPIFY_APP_BASE']}/webhooks/theme_updated", format: 'json'}
  ]

But none of those webhooks are registered when a new shop installs.

Expected behavior

The webhooks should be registered.

Actual behavior

The webhooks are not registered.

Steps to reproduce the problem

1. Configure some webhooks in config.webhooks
2. Install the app in a shop
3. Notice that webhooks are not registered

[uurcank]

I think it has all moved to shopify.toml file with shopify managed scopes.

[jagthedrummer]

@uurcank I'm not finding anything in the changelog saying that webhooks won't be registered anymore, and the docs still describe using them: https://github.com/Shopify/shopify_app/blob/main/docs/shopify_app/webhooks.md#manage-shop-specific-webhooks-using-shopifyappwebhooksmanager

[remy727]

How did you add the webhook?
Did you add the webhook using add_webhook generator?

rails g shopify_app:add_webhook --topic carts/update --path webhooks/carts_update

[jagthedrummer]

@remy727 I honestly don't remember how I added them. This is in an app that I've been running for a while and I just noticed that somewhere along the way it stopped registering webhooks. If I manually register the webhooks they work as expected, so it's not a problem with file paths or namespaces or any of the other magic bits that this gem provides. It's just that the automatic registration from the config isn't happening.

[lizkenyon]

Hi 👋

I was not able to reproduce this on my side using the Shopify App Template Ruby, and setting up API webhooks in the config object. My webhook subscription was successfully created.

It may be helpful for debugging to take a look at this commit, it is showing the code required in the shopify_app.rb for setting up the webhooks.

It may also be helpful to review the logs from your app after install.
You should see the webhooks job being called after token exchange.

14:33:00 │               web-backend │   Shop Load (0.1ms)  SELECT "shops".* FROM "shops" WHERE "shops"."shopify_domain" = ? LIMIT ?  [["shopify_domain", ".myshopify.com"],
["LIMIT", 1]]
14:33:00 │               web-backend │ [ ShopifyApp | INFO | Shop Not Found ] Performing Token Exchange for [.myshopify.com] - (Offline)
14:33:01 │               web-backend │   CACHE Shop Load (0.0ms)  SELECT "shops".* FROM "shops" WHERE "shops"."shopify_domain" = ? LIMIT ?  [["shopify_domain", ".myshopify.com"],
["LIMIT", 1]]
14:33:01 │               web-backend │   TRANSACTION (0.1ms)  begin transaction
14:33:01 │               web-backend │   Shop Exists? (21.7ms)  SELECT 1 AS one FROM "shops" WHERE LOWER("shops"."shopify_domain") = LOWER(?) LIMIT ?  [["shopify_domain",
"i.myshopify.com"], ["LIMIT", 1]]
14:33:01 │               web-backend │   Shop Create (1.2ms)  INSERT INTO "shops" ("shopify_domain", "shopify_token", "created_at", "updated_at", "access_scopes") VALUES (?, ?, ?, ?, ?) RETURNING "id"
[["shopify_domain", ".myshopify.com"], ["shopify_token", "[FILTERED]"], ["created_at", "2025-02-18 20:33:01.202588"], ["updated_at", "2025-02-18 20:33:01.202588"],
["access_scopes", "write_products"]]
14:33:01 │               web-backend │   TRANSACTION (0.4ms)  commit transaction
14:33:01 │               web-backend │ [ActiveJob] Enqueued ShopifyApp::WebhooksManagerJob (Job ID: 59461a7c-9c9a-415f-9e1e-9ccc6e01a285) to Async(default)
14:33:01 │               web-backend │   Shop Load (0.1ms)  SELECT "shops".* FROM "shops" WHERE "shops"."shopify_domain" = ? LIMIT ?  [["shopify_domain", ".myshopify.com"],
["LIMIT", 1]]
14:33:01 │               web-backend │   Rendering text template
14:33:01 │               web-backend │   Rendered text template (Duration: 0.0ms | Allocations: 4)
14:33:01 │               web-backend │ Completed 200 OK in 616ms (Views: 3.2ms | ActiveRecord: 25.4ms | Allocations: 110749)
14:33:01 │               web-backend │
14:33:01 │               web-backend │
14:33:01 │               web-backend │ [ActiveJob] [ShopifyApp::WebhooksManagerJob] [59461a7c-9c9a-415f-9e1e-9ccc6e01a285] Performing ShopifyApp::WebhooksManagerJob (Job ID: 59461a7c-9c9a-415f-9e1e-9ccc6e01a285)
from Async(default) enqueued at 2025-02-18T20:33:01.207717000Z
14:33:02 │               web-backend │ [ActiveJob] [ShopifyApp::WebhooksManagerJob] [59461a7c-9c9a-415f-9e1e-9ccc6e01a285] Performed ShopifyApp::WebhooksManagerJob (Job ID: 59461a7c-9c9a-415f-9e1e-9ccc6e01a285)
from Async(default) in 1008.84ms

[github-actions]

We are closing this issue because we did not hear back regarding additional details we needed to resolve this issue. If the issue persists and you are able to provide the missing clarification we need, feel free to respond and reopen this issue.

We appreciate your understanding as we try to manage our number of open issues.

[jagthedrummer]

It turns out that this was related to having to deal with the premature removal of the ScriptTagsManager (#1891). The recommendation of implementing custom_post_authenticate_tasks did not mention that doing so would stop the automatic registering of webhooks. It continues to feel hostile that you all are removing code for features that are not even officially deprecated.

And the bot auto-closing issues after only one week feels even more hostile. Please disable that thing.

[jagthedrummer]

Also, the bot says this:

feel free to respond and reopen this issue.

But reopening auto-closed issues doesn't seem to be allowed.

[vjnunez]

Hey @jagthedrummer, im having the same issue with webhooks not auto registering in the shop. How did you solve this? I just created a new app using shopify_app gem.

[jagthedrummer]

@vjnunez I ended up writing custom code to register the webhooks manually and added it to the class that I registered as custom_post_authenticate_tasks.