Merge pull request #2047 from Shopify/fix-webhook-generator-issue

[patch] Fix TypeError in webhook job templates with shopify_api >= 16.0.0

Author: lizkenyon

CHANGELOG.md

@@ -1,5 +1,6 @@
 Unreleased
 ----------
+- [Patch] Fix sorbet errors in generated webhook handlers
 
 23.0.1 (December 22, 2025)
 - Fix engine initialization [#2040](https://github.com/Shopify/shopify_app/pull/2040)

lib/generators/shopify_app/add_app_uninstalled_job/templates/app_uninstalled_job.rb.tt

@@ -1,10 +1,8 @@
 class AppUninstalledJob < ActiveJob::Base
-  include ShopifyAPI::Webhooks::WebhookHandler
+  extend ShopifyAPI::Webhooks::WebhookHandler
 
-  class << self
-    def handle(topic:, shop:, body:, webhook_id:, api_version:)
-      perform_later(topic: topic, shop_domain: shop, webhook: body)
-    end
+  def self.handle(topic:, shop:, body:, webhook_id:, api_version:)
+    perform_later(topic: topic, shop_domain: shop, webhook: body)
   end
 
   def perform(topic:, shop_domain:, webhook:)

lib/generators/shopify_app/add_privacy_jobs/templates/customers_data_request_job.rb.tt

@@ -1,10 +1,8 @@
 class CustomersDataRequestJob < ActiveJob::Base
-  include ShopifyAPI::Webhooks::WebhookHandler
+  extend ShopifyAPI::Webhooks::WebhookHandler
 
-  class << self
-    def handle(topic:, shop:, body:, webhook_id:, api_version:)
-      perform_later(topic: topic, shop_domain: shop, webhook: body)
-    end
+  def self.handle(topic:, shop:, body:, webhook_id:, api_version:)
+    perform_later(topic: topic, shop_domain: shop, webhook: body)
   end
 
   def perform(topic:, shop_domain:, webhook:)

lib/generators/shopify_app/add_privacy_jobs/templates/customers_redact_job.rb.tt

@@ -1,10 +1,8 @@
 class CustomersRedactJob < ActiveJob::Base
-  include ShopifyAPI::Webhooks::WebhookHandler
+  extend ShopifyAPI::Webhooks::WebhookHandler
 
-  class << self
-    def handle(topic:, shop:, body:, webhook_id:, api_version:)
-      perform_later(topic: topic, shop_domain: shop, webhook: body)
-    end
+  def self.handle(topic:, shop:, body:, webhook_id:, api_version:)
+    perform_later(topic: topic, shop_domain: shop, webhook: body)
   end
 
   def perform(topic:, shop_domain:, webhook:)

lib/generators/shopify_app/add_privacy_jobs/templates/shop_redact_job.rb.tt

@@ -1,10 +1,8 @@
 class ShopRedactJob < ActiveJob::Base
-  include ShopifyAPI::Webhooks::WebhookHandler
+  extend ShopifyAPI::Webhooks::WebhookHandler
 
-  class << self
-    def handle(topic:, shop:, body:, webhook_id:, api_version:)
-      perform_later(topic: topic, shop_domain: shop, webhook: body)
-    end
+  def self.handle(topic:, shop:, body:, webhook_id:, api_version:)
+    perform_later(topic: topic, shop_domain: shop, webhook: body)
   end
 
   def perform(topic:, shop_domain:, webhook:)

lib/generators/shopify_app/add_webhook/templates/webhook_job.rb.tt

@@ -1,10 +1,8 @@
 class <%= @job_class_name %> < ActiveJob::Base
-  include ShopifyAPI::Webhooks::WebhookHandler
+  extend ShopifyAPI::Webhooks::WebhookHandler
 
-  class << self
-    def handle(topic:, shop:, body:, webhook_id:, api_version:)
-      perform_later(topic: topic, shop_domain: shop, webhook: body)
-    end
+  def self.handle(topic:, shop:, body:, webhook_id:, api_version:)
+    perform_later(topic: topic, shop_domain: shop, webhook: body)
   end
 
   def perform(topic:, shop_domain:, webhook:)