data object containing the serialized resource:
| Field | Type | Description |
|---|---|---|
id | string | Unique UUID for this event |
name | string | Event name (e.g., order.completed) |
created_at | string | ISO 8601 timestamp |
data | object | Serialized resource (see payloads below) |
metadata | object | Additional context including Spree version |
id fields use prefixed IDs (e.g., or_m3Rp9wXz, prod_86Rf07xd4z). All monetary values are strings. All timestamps are ISO 8601.
For details on creating webhook endpoints and verifying signatures, see Webhooks. For the event system internals and subscriber pattern, see Events.
Event payloads include the same top-level attributes and unconditional associations as API responses. Conditional associations (like product variants, images, or metafields) are not included in event payloads.
Order Events
Events:order.created, order.updated, order.completed, order.canceled, order.resumed, order.paid, order.shipped
Order payloads include nested items, shipments, payments, bill_address, ship_address, payment_methods, and promotions.
Line Item Events
Events:line_item.created, line_item.updated, line_item.deleted
Line item payloads include nested option_values and digital_links.
Payment Events
Events:payment.created, payment.updated, payment.paid
Payment payloads include a nested payment_method and polymorphic source (credit card, store credit, or payment source).
source_type field is normalized to one of: "credit_card", "store_credit", "payment_source", or null.
Payment Session Events
Events:payment_session.created, payment_session.updated, payment_session.deleted
Payment session payloads include a nested payment_method and optionally a nested payment.
Payment Setup Session Events
Events:payment_setup_session.created, payment_setup_session.updated, payment_setup_session.deleted
Payment setup session payloads include a nested payment_method.
Shipment Events
Events:shipment.created, shipment.updated, shipment.shipped, shipment.canceled, shipment.resumed
Shipment payloads include nested shipping_method, stock_location, and shipping_rates.
Product Events
Events:product.created, product.updated, product.deleted, product.activate, product.archive, product.out_of_stock, product.back_in_stock
Product event payloads include pricing, stock status, and availability flags. Conditional associations (variants, images, option types, taxons, metafields) are not included in event payloads.
Variant Events
Events:variant.created, variant.updated, variant.deleted
Variant event payloads include pricing, stock status, and always-included option_values. Conditional associations (images, metafields) are not included in event payloads.
Price Events
Events:price.created, price.updated, price.deleted
Image Events
Events:image.created, image.updated, image.deleted
Image payloads include URLs for all configured image variants (mini, small, medium, large, xlarge).
Stock Item Events
Events:stock_item.created, stock_item.updated, stock_item.deleted
Stock Movement Events
Events:stock_movement.created, stock_movement.updated, stock_movement.deleted
Stock Transfer Events
Events:stock_transfer.created, stock_transfer.updated, stock_transfer.deleted
Customer Events
Events:customer.created, customer.updated, customer.deleted
Customer payloads include nested addresses, default_billing_address, and default_shipping_address.
Promotion Events
Events:promotion.created, promotion.updated, promotion.deleted
Gift Card Events
Events:gift_card.created, gift_card.updated, gift_card.deleted
The gift card
code is displayed as a masked value (e.g., ****-1234) for security.Gift Card Batch Events
Events:gift_card_batch.created, gift_card_batch.updated, gift_card_batch.deleted
Store Credit Events
Events:store_credit.created, store_credit.updated, store_credit.deleted
Refund Events
Events:refund.created, refund.updated, refund.deleted
Reimbursement Events
Events:reimbursement.created, reimbursement.updated, reimbursement.deleted
Return Authorization Events
Events:return_authorization.created, return_authorization.updated, return_authorization.deleted
Return Item Events
Events:return_item.created, return_item.updated, return_item.deleted
Customer Return Events
Events:customer_return.created, customer_return.updated, customer_return.deleted
Wishlist Events
Events:wishlist.created, wishlist.updated, wishlist.deleted
Wishlist items are a conditional association and are not included in event payloads.
Wished Item Events
Events:wished_item.created, wished_item.updated, wished_item.deleted
Wished item payloads include a nested variant.
Post Events
Events:post.created, post.updated, post.deleted
Post Category Events
Events:post_category.created, post_category.updated, post_category.deleted
Newsletter Subscriber Events
Events:newsletter_subscriber.created, newsletter_subscriber.updated, newsletter_subscriber.deleted
Digital Product Events
Events:digital.created, digital.updated, digital.deleted
Digital Link Events
Events:digital_link.created, digital_link.updated, digital_link.deleted
Import Events
Events:import.created, import.updated, import.deleted
Import Row Events
Events:import_row.created, import_row.updated, import_row.deleted
Export Events
Events:export.created, export.updated, export.deleted
Report Events
Events:report.created, report.updated, report.deleted
Invitation Events
Events:invitation.created, invitation.updated, invitation.deleted

