Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Improve webhook payloads

Damian Legawiec73b07b3420ba
diff --git a/api/app/subscribers/spree/webhook_event_subscriber.rb b/api/app/subscribers/spree/webhook_event_subscriber.rb
index 977210c080..e429910bf5 100644
--- a/api/app/subscribers/spree/webhook_event_subscriber.rb
+++ b/api/app/subscribers/spree/webhook_event_subscriber.rb
@@ -48,9 +48,6 @@ module Spree
payload: payload
)
- # Add webhook_delivery_id to payload
- delivery.update_column(:payload, payload.merge(webhook_delivery_id: delivery.id))
-
# Queue the delivery job
Spree::WebhookDeliveryJob.perform_later(delivery.id, endpoint.secret_key)
rescue StandardError => e
@@ -61,9 +58,10 @@ module Spree
def build_payload(event)
{
id: event.id,
- event: event.name,
+ name: event.name,
created_at: event.created_at.iso8601,
- data: event.payload
+ data: event.payload,
+ metadata: event.metadata
}
end
end
diff --git a/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb b/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb
index 8e40d7162a..ef274efd2b 100644
--- a/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb
+++ b/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb
@@ -40,13 +40,12 @@ module Spree
expect(delivery.url).to eq(webhook_endpoint.url)
expect(delivery.webhook_endpoint).to eq(webhook_endpoint)
- # Reload to get the updated payload with webhook_delivery_id
delivery.reload
expect(delivery.payload).to include(
'id' => event_id,
- 'event' => event_name,
- 'webhook_delivery_id' => delivery.id,
- 'data' => event_payload.stringify_keys
+ 'name' => event_name,
+ 'data' => event_payload.stringify_keys,
+ 'metadata' => event_metadata.stringify_keys
)
expect(delivery.payload['created_at']).to eq(event_created_at.iso8601)
end
diff --git a/core/app/models/concerns/spree/publishable.rb b/core/app/models/concerns/spree/publishable.rb
index 4ecfd4726f..6d4f16b9d4 100644
--- a/core/app/models/concerns/spree/publishable.rb
+++ b/core/app/models/concerns/spree/publishable.rb
@@ -161,7 +161,7 @@ module Spree
@_current_event_name = event_name
payload ||= event_payload
- Spree::Events.publish(event_name, payload, metadata.merge(default_event_metadata))
+ Spree::Events.publish(event_name, payload, metadata)
ensure
@_current_event_name = nil
end
@@ -231,13 +231,6 @@ module Spree
self.class.publish_events && Spree::Events.enabled?
end
- def default_event_metadata
- {
- model_class: self.class.name,
- model_id: try(:id)
- }
- end
-
def publish_create_event
publish_event("#{event_prefix}.created")
end
diff --git a/core/app/models/spree/event.rb b/core/app/models/spree/event.rb
index 269639d85e..fa8e3f83e6 100644
--- a/core/app/models/spree/event.rb
+++ b/core/app/models/spree/event.rb
@@ -104,20 +104,10 @@ module Spree
def build_metadata(custom_metadata)
base_metadata = {
- 'spree_version' => Spree.version
+ 'spree_version' => Spree.version,
+ 'store_id' => Spree::Store.current&.id
}
- # Add store context if available
- if defined?(Spree::Store) && Spree::Store.respond_to?(:current)
- current_store = Spree::Store.current
- base_metadata['store_id'] = current_store&.id&.to_s
- end
-
- # Add request context if available (via CurrentAttributes or similar)
- if defined?(Current) && Current.respond_to?(:request_id)
- base_metadata['request_id'] = Current.request_id
- end
-
base_metadata.merge((custom_metadata || {}).deep_stringify_keys)
end
end