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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Add Webhooks to Admin API/SDK and Dashboard
Damian Legawiecfa48f9a2c33b
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yamlindex 92a3ba97df..8fe1dec3a9 100644--- a/docs/api-reference/admin.yaml+++ b/docs/api-reference/admin.yaml@@ -82,12 +82,12 @@ paths:example:data:- id: admin_UkLWZg9DAJ- email: [email protected]- first_name: Kandy- last_name: Dach- full_name: Kandy Dach- created_at: '2026-06-01T13:00:32.279Z'- updated_at: '2026-06-01T13:00:32.279Z'+ email: [email protected]+ first_name: Cristine+ last_name: Kutch+ full_name: Cristine Kutch+ created_at: '2026-06-05T13:11:36.683Z'+ updated_at: '2026-06-05T13:11:36.683Z'roles:- id: role_UkLWZg9DAJname: admin@@ -145,12 +145,12 @@ paths:application/json:example:id: admin_UkLWZg9DAJ- email: [email protected]- first_name: Jerica- last_name: Watsica- full_name: Jerica Watsica- created_at: '2026-06-01T13:00:32.617Z'- updated_at: '2026-06-01T13:00:32.617Z'+ email: [email protected]+ first_name: Ernie+ last_name: Hammes+ full_name: Ernie Hammes+ created_at: '2026-06-05T13:11:37.020Z'+ updated_at: '2026-06-05T13:11:37.020Z'roles:- id: role_UkLWZg9DAJname: admin@@ -203,12 +203,12 @@ paths:application/json:example:id: admin_UkLWZg9DAJ- email: [email protected]+ email: [email protected]first_name: Renamed- last_name: Shields- full_name: Renamed Shields- created_at: '2026-06-01T13:00:32.918Z'- updated_at: '2026-06-01T13:00:32.933Z'+ last_name: Bruen+ full_name: Renamed Bruen+ created_at: '2026-06-05T13:11:37.300Z'+ updated_at: '2026-06-05T13:11:37.317Z'roles:- id: role_UkLWZg9DAJname: admin@@ -350,9 +350,8 @@ paths:data:- id: ao_UkLWZg9DAJorigin: https://shop.example.com- created_at: '2026-06-01T13:00:33.226Z'- updated_at: '2026-06-01T13:00:33.226Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:37.617Z'+ updated_at: '2026-06-05T13:11:37.617Z'meta:page: 1limit: 25@@ -433,9 +432,8 @@ paths:example:id: ao_gbHJdmfrXBorigin: https://admin.example.com- created_at: '2026-06-01T13:00:33.843Z'- updated_at: '2026-06-01T13:00:33.843Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:38.223Z'+ updated_at: '2026-06-05T13:11:38.223Z'schema:"$ref": "#/components/schemas/AllowedOrigin"'422':@@ -519,9 +517,8 @@ paths:example:id: ao_UkLWZg9DAJorigin: https://shop.example.com- created_at: '2026-06-01T13:00:34.139Z'- updated_at: '2026-06-01T13:00:34.139Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:38.548Z'+ updated_at: '2026-06-05T13:11:38.548Z'schema:"$ref": "#/components/schemas/AllowedOrigin"'404':@@ -579,9 +576,8 @@ paths:example:id: ao_UkLWZg9DAJorigin: https://www.example.com- created_at: '2026-06-01T13:00:34.716Z'- updated_at: '2026-06-01T13:00:34.994Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:39.123Z'+ updated_at: '2026-06-05T13:11:39.399Z'schema:"$ref": "#/components/schemas/AllowedOrigin"'422':@@ -695,32 +691,32 @@ paths:key_type: publishabletoken_prefix:scopes: []- created_at: '2026-06-01T13:00:35.563Z'- updated_at: '2026-06-01T13:00:35.563Z'+ created_at: '2026-06-05T13:11:39.966Z'+ updated_at: '2026-06-05T13:11:39.966Z'revoked_at:last_used_at:- plaintext_token: pk_X5qdCiAFfkyM8JRzA1nc8d6a+ plaintext_token: pk_vwf79N3EbY55iFtDfBjti1uecreated_by_email:- id: key_gbHJdmfrXBname: Backend integrationkey_type: secret- token_prefix: sk_j5N5Gq53H+ token_prefix: sk_SQrcKStFCscopes:- write_all- created_at: '2026-06-01T13:00:35.564Z'- updated_at: '2026-06-01T13:00:35.564Z'+ created_at: '2026-06-05T13:11:39.967Z'+ updated_at: '2026-06-05T13:11:39.967Z'revoked_at:last_used_at:plaintext_token:created_by_email:- id: key_EfhxLZ9ck8- name: sequi+ name: officiiskey_type: secret- token_prefix: sk_52p3ctf42+ token_prefix: sk_CbfihKFYJscopes:- write_all- created_at: '2026-06-01T13:00:35.565Z'- updated_at: '2026-06-01T13:00:35.565Z'+ created_at: '2026-06-05T13:11:39.968Z'+ updated_at: '2026-06-05T13:11:39.968Z'revoked_at:last_used_at:plaintext_token:@@ -783,15 +779,15 @@ paths:id: key_VqXmZF31wYname: CI keykey_type: secret- token_prefix: sk_hdVLD3kea+ token_prefix: sk_nRJk8UWArscopes:- read_orders- created_at: '2026-06-01T13:00:36.146Z'- updated_at: '2026-06-01T13:00:36.146Z'+ created_at: '2026-06-05T13:11:40.519Z'+ updated_at: '2026-06-05T13:11:40.519Z'revoked_at:last_used_at:- plaintext_token: sk_hdVLD3keaZjTsnEumf28FbFy- created_by_email: [email protected]+ plaintext_token: sk_nRJk8UWAreSGDgitF8WmLkW6+ created_by_email: [email protected]'422':description: validation errorcontent:@@ -877,11 +873,11 @@ paths:key_type: publishabletoken_prefix:scopes: []- created_at: '2026-06-01T13:00:36.433Z'- updated_at: '2026-06-01T13:00:36.433Z'+ created_at: '2026-06-05T13:11:40.807Z'+ updated_at: '2026-06-05T13:11:40.807Z'revoked_at:last_used_at:- plaintext_token: pk_mJJoncofqeMtfc2vYy6gL1K5+ plaintext_token: pk_rMmsAxGPjseAjBerbb8tbLHBcreated_by_email:delete:summary: Delete an API key@@ -971,12 +967,12 @@ paths:id: key_gbHJdmfrXBname: Backend integrationkey_type: secret- token_prefix: sk_geeWhiD86+ token_prefix: sk_DdooMj4rLscopes:- write_all- created_at: '2026-06-01T13:00:37.015Z'- updated_at: '2026-06-01T13:00:37.296Z'- revoked_at: '2026-06-01T13:00:37.295Z'+ created_at: '2026-06-05T13:11:41.386Z'+ updated_at: '2026-06-05T13:11:41.661Z'+ revoked_at: '2026-06-05T13:11:41.660Z'last_used_at:plaintext_token:created_by_email:@@ -1030,15 +1026,15 @@ paths:content:application/json:example:- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjM2NDUzNGQ1LTNhNjAtNGFmMS1hOTQyLTBiZTdiN2Y2OTJhMSIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzgwMzE5MTM3fQ.DHFxVQDB7L2thH76UQO6wgRdFeqFdduikuvK-2GZ13s+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjA1MDE2NWYyLWIxMzgtNGUxNS1hODQzLTViOGQ3ZmQwNDRiNiIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzgwNjY1NDAyfQ.kRkK_K3OdO_o-Nt1pqtAYJSsL0xmTAby07V95YGqhQUuser:id: admin_UkLWZg9DAJemail: [email protected]- first_name: Forest- last_name: Hudson- full_name: Forest Hudson- created_at: '2026-06-01T13:00:37.563Z'- updated_at: '2026-06-01T13:00:37.563Z'+ first_name: Ingrid+ last_name: Powlowski+ full_name: Ingrid Powlowski+ created_at: '2026-06-05T13:11:41.926Z'+ updated_at: '2026-06-05T13:11:41.926Z'roles:- id: role_UkLWZg9DAJname: admin@@ -1133,15 +1129,15 @@ paths:content:application/json:example:- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6ImQyOTk3ZmFhLWY0OTktNDVlZi1hOWMzLTcwMDgxYzMwY2Q0OCIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzgwMzE5MTM4fQ.Ne8EKFBlQrpBnqXp612epnmTXKbY_QuIzgRHtCpn4DU+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6ImNiOGQ2OWI5LWQzNzMtNDFkYy1iZWRhLWZmMjk2MDQ1MGQ5MiIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzgwNjY1NDAzfQ.Y008gMr0LiwTlG-IYbvK9jrpa33-dRJ95ZvYHguEG20user:id: admin_UkLWZg9DAJemail: [email protected]- first_name: Ulysses- last_name: Larson- full_name: Ulysses Larson- created_at: '2026-06-01T13:00:38.669Z'- updated_at: '2026-06-01T13:00:38.669Z'+ first_name: Grayce+ last_name: Muller+ full_name: Grayce Muller+ created_at: '2026-06-05T13:11:43.008Z'+ updated_at: '2026-06-05T13:11:43.008Z'roles:- id: role_UkLWZg9DAJname: admin@@ -1231,18 +1227,18 @@ paths:name: Online Storecode: onlineactive: true+ default: truepreferred_order_routing_strategy:- created_at: '2026-06-01T13:00:31.963Z'- updated_at: '2026-06-01T13:00:31.963Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:36.367Z'+ updated_at: '2026-06-05T13:11:36.367Z'- id: ch_gbHJdmfrXBname: Wholesalecode: wholesaleactive: true+ default: falsepreferred_order_routing_strategy:- created_at: '2026-06-01T13:00:39.253Z'- updated_at: '2026-06-01T13:00:39.253Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:43.589Z'+ updated_at: '2026-06-05T13:11:43.589Z'meta:page: 1limit: 25@@ -1300,10 +1296,10 @@ paths:name: Marketplacecode: marketplaceactive: true+ default: falsepreferred_order_routing_strategy:- created_at: '2026-06-01T13:00:39.822Z'- updated_at: '2026-06-01T13:00:39.822Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:44.163Z'+ updated_at: '2026-06-05T13:11:44.163Z'requestBody:content:application/json:@@ -1358,10 +1354,10 @@ paths:name: Wholesalecode: wholesaleactive: true+ default: falsepreferred_order_routing_strategy:- created_at: '2026-06-01T13:00:39.832Z'- updated_at: '2026-06-01T13:00:39.832Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:44.190Z'+ updated_at: '2026-06-05T13:11:44.190Z'patch:summary: Update a channeltags:@@ -1391,10 +1387,10 @@ paths:name: Wholesale (Updated)code: wholesaleactive: true+ default: falsepreferred_order_routing_strategy:- created_at: '2026-06-01T13:00:40.121Z'- updated_at: '2026-06-01T13:00:40.403Z'- store_id: store_UkLWZg9DAJ+ created_at: '2026-06-05T13:11:44.493Z'+ updated_at: '2026-06-05T13:11:44.841Z'requestBody:content:application/json:@@ -1599,15 +1595,15 @@ paths:- id: coupon_UkLWZg9DAJcode: AAA111state: unused- created_at: '2026-06-01T13:00:41.555Z'- updated_at: '2026-06-01T13:00:41.555Z'+ created_at: '2026-06-05T13:11:45.879Z'+ updated_at: '2026-06-05T13:11:45.879Z'promotion_id: promo_UkLWZg9DAJorder_id:- id: coupon_gbHJdmfrXBcode: BBB222state: unused- created_at: '2026-06-01T13:00:41.557Z'- updated_at: '2026-06-01T13:00:41.557Z'+ created_at: '2026-06-05T13:11:45.879Z'+ updated_at: '2026-06-05T13:11:45.879Z'promotion_id: promo_UkLWZg9DAJorder_id:meta:@@ -1685,8 +1681,8 @@ paths:field_type: short_textresource_type: Spree::Productstorefront_visible: true- created_at: '2026-06-01T13:00:41.894Z'- updated_at: '2026-06-01T13:00:41.894Z'+ created_at: '2026-06-05T13:11:46.203Z'+ updated_at: '2026-06-05T13:11:46.203Z'- id: cfdef_gbHJdmfrXBnamespace: customkey: order_notes@@ -1694,8 +1690,8 @@ paths:field_type: short_textresource_type: Spree::Orderstorefront_visible: true- created_at: '2026-06-01T13:00:41.895Z'- updated_at: '2026-06-01T13:00:41.895Z'+ created_at: '2026-06-05T13:11:46.204Z'+ updated_at: '2026-06-05T13:11:46.204Z'meta:page: 1limit: 25@@ -1758,8 +1754,8 @@ paths:field_type: short_textresource_type: Spree::Productstorefront_visible: true- created_at: '2026-06-01T13:00:42.602Z'- updated_at: '2026-06-01T13:00:42.602Z'+ created_at: '2026-06-05T13:11:46.788Z'+ updated_at: '2026-06-05T13:11:46.788Z'requestBody:content:application/json:@@ -1842,8 +1838,8 @@ paths:field_type: short_textresource_type: Spree::Productstorefront_visible: true- created_at: '2026-06-01T13:00:42.610Z'- updated_at: '2026-06-01T13:00:42.610Z'+ created_at: '2026-06-05T13:11:46.793Z'+ updated_at: '2026-06-05T13:11:46.793Z'patch:summary: Update a custom field definitiontags:@@ -1882,8 +1878,8 @@ paths:field_type: short_textresource_type: Spree::Productstorefront_visible: false- created_at: '2026-06-01T13:00:42.954Z'- updated_at: '2026-06-01T13:00:43.237Z'+ created_at: '2026-06-05T13:11:47.078Z'+ updated_at: '2026-06-05T13:11:47.360Z'requestBody:content:application/json:@@ -2007,14 +2003,14 @@ paths:name: VIPsdescription: Top spenderscustomers_count: 0- created_at: '2026-06-01T13:00:43.534Z'- updated_at: '2026-06-01T13:00:43.534Z'+ created_at: '2026-06-05T13:11:47.654Z'+ updated_at: '2026-06-05T13:11:47.654Z'- id: cg_gbHJdmfrXBname: Wholesaledescription:customers_count: 0- created_at: '2026-06-01T13:00:43.535Z'- updated_at: '2026-06-01T13:00:43.535Z'+ created_at: '2026-06-05T13:11:47.655Z'+ updated_at: '2026-06-05T13:11:47.655Z'meta:page: 1limit: 25@@ -2099,8 +2095,8 @@ paths:name: Wholesale 2description: B2B accountscustomers_count: 1- created_at: '2026-06-01T13:00:44.429Z'- updated_at: '2026-06-01T13:00:44.429Z'+ created_at: '2026-06-05T13:11:48.527Z'+ updated_at: '2026-06-05T13:11:48.527Z'schema:"$ref": "#/components/schemas/CustomerGroup"'422':@@ -2206,24 +2202,24 @@ paths:name: VIPsdescription: Top spenderscustomers_count: 1- created_at: '2026-06-01T13:00:45.027Z'- updated_at: '2026-06-01T13:00:45.027Z'+ created_at: '2026-06-05T13:11:49.112Z'+ updated_at: '2026-06-05T13:11:49.112Z'customers:- id: cus_UkLWZg9DAJ- email: [email protected]- first_name: Hal- last_name: Crona+ email: [email protected]+ first_name: Adella+ last_name: Mertzphone:accepts_email_marketing: false- full_name: Hal Crona+ full_name: Adella Mertzavailable_store_credit_total: '0'display_available_store_credit_total: "$0.00"- login: [email protected]+ login: [email protected]metadata: {}last_sign_in_at:current_sign_in_at:- created_at: '2026-06-01T13:00:45.296Z'- updated_at: '2026-06-01T13:00:45.296Z'+ created_at: '2026-06-05T13:11:49.376Z'+ updated_at: '2026-06-05T13:11:49.376Z'sign_in_count: 0failed_attempts: 0last_sign_in_ip:@@ -2301,8 +2297,8 @@ paths:name: VIP customers (Q1)description: Top spenderscustomers_count: 0- created_at: '2026-06-01T13:00:45.928Z'- updated_at: '2026-06-01T13:00:46.212Z'+ created_at: '2026-06-05T13:11:49.974Z'+ updated_at: '2026-06-05T13:11:50.254Z'schema:"$ref": "#/components/schemas/CustomerGroup"'422':@@ -2455,8 +2451,8 @@ paths:state_name: New Yorklabel:metadata: {}- created_at: '2026-06-01T13:00:47.062Z'- updated_at: '2026-06-01T13:00:47.062Z'+ created_at: '2026-06-05T13:11:51.157Z'+ updated_at: '2026-06-05T13:11:51.157Z'customer_id: cus_UkLWZg9DAJmeta:page: 1@@ -2544,8 +2540,8 @@ paths:state_name: New Yorklabel: Officemetadata: {}- created_at: '2026-06-01T13:00:48.495Z'- updated_at: '2026-06-01T13:00:48.495Z'+ created_at: '2026-06-05T13:11:52.510Z'+ updated_at: '2026-06-05T13:11:52.510Z'customer_id: cus_UkLWZg9DAJrequestBody:content:@@ -2656,8 +2652,8 @@ paths:state_name: New Yorklabel:metadata: {}- created_at: '2026-06-01T13:00:48.776Z'- updated_at: '2026-06-01T13:00:49.312Z'+ created_at: '2026-06-05T13:11:52.780Z'+ updated_at: '2026-06-05T13:11:53.330Z'customer_id: cus_UkLWZg9DAJrequestBody:content:@@ -2790,8 +2786,8 @@ paths:customer_id: cus_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJmetadata: {}- created_at: '2026-06-01T13:00:50.416Z'- updated_at: '2026-06-01T13:00:50.416Z'+ created_at: '2026-06-05T13:11:54.435Z'+ updated_at: '2026-06-05T13:11:54.435Z'meta:page: 1limit: 25@@ -2878,8 +2874,8 @@ paths:customer_id: cus_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJmetadata: {}- created_at: '2026-06-01T13:00:50.970Z'- updated_at: '2026-06-01T13:00:50.970Z'+ created_at: '2026-06-05T13:11:54.997Z'+ updated_at: '2026-06-05T13:11:54.997Z'delete:summary: Delete a customer credit cardtags:@@ -2998,8 +2994,8 @@ paths:currency: USDmemo:metadata: {}- created_at: '2026-06-01T13:00:52.345Z'- updated_at: '2026-06-01T13:00:52.345Z'+ created_at: '2026-06-05T13:11:56.393Z'+ updated_at: '2026-06-05T13:11:56.393Z'customer_id: cus_UkLWZg9DAJcreated_by_id: admin_UkLWZg9DAJcategory_id: sccat_UkLWZg9DAJ@@ -3074,8 +3070,8 @@ paths:currency: USDmemo: Goodwillmetadata: {}- created_at: '2026-06-01T13:00:53.461Z'- updated_at: '2026-06-01T13:00:53.461Z'+ created_at: '2026-06-05T13:11:57.509Z'+ updated_at: '2026-06-05T13:11:57.509Z'customer_id: cus_UkLWZg9DAJcreated_by_id: admin_gbHJdmfrXBcategory_id: sccat_UkLWZg9DAJ@@ -3166,8 +3162,8 @@ paths:currency: USDmemo: Updatedmetadata: {}- created_at: '2026-06-01T13:00:54.009Z'- updated_at: '2026-06-01T13:00:54.296Z'+ created_at: '2026-06-05T13:11:58.047Z'+ updated_at: '2026-06-05T13:11:58.336Z'customer_id: cus_UkLWZg9DAJcreated_by_id: admin_UkLWZg9DAJcategory_id: sccat_UkLWZg9DAJ@@ -3321,8 +3317,8 @@ paths:metadata: {}last_sign_in_at:current_sign_in_at:- created_at: '2026-06-01T13:00:55.402Z'- updated_at: '2026-06-01T13:00:55.402Z'+ created_at: '2026-06-05T13:11:59.447Z'+ updated_at: '2026-06-05T13:11:59.447Z'sign_in_count: 0failed_attempts: 0last_sign_in_ip:@@ -3405,8 +3401,8 @@ paths:metadata: {}last_sign_in_at:current_sign_in_at:- created_at: '2026-06-01T13:00:56.239Z'- updated_at: '2026-06-01T13:00:56.239Z'+ created_at: '2026-06-05T13:12:00.292Z'+ updated_at: '2026-06-05T13:12:00.292Z'sign_in_count: 0failed_attempts: 0last_sign_in_ip:@@ -3522,8 +3518,8 @@ paths:metadata: {}last_sign_in_at:current_sign_in_at:- created_at: '2026-06-01T13:00:56.509Z'- updated_at: '2026-06-01T13:00:56.509Z'+ created_at: '2026-06-05T13:12:00.565Z'+ updated_at: '2026-06-05T13:12:00.565Z'sign_in_count: 0failed_attempts: 0last_sign_in_ip:@@ -3597,8 +3593,8 @@ paths:metadata: {}last_sign_in_at:current_sign_in_at:- created_at: '2026-06-01T13:00:57.058Z'- updated_at: '2026-06-01T13:00:57.342Z'+ created_at: '2026-06-05T13:12:01.125Z'+ updated_at: '2026-06-05T13:12:01.412Z'sign_in_count: 0failed_attempts: 0last_sign_in_ip:@@ -4028,11 +4024,11 @@ paths:example:data:- id: exp_UkLWZg9DAJ- number: EF234630368+ number: EF364027755type: Spree::Exports::Productsformat: csv- created_at: '2026-06-01T13:01:01.474Z'- updated_at: '2026-06-01T13:01:01.474Z'+ created_at: '2026-06-05T13:12:05.577Z'+ updated_at: '2026-06-05T13:12:05.577Z'user_id: admin_UkLWZg9DAJdone: falsefilename:@@ -4099,11 +4095,11 @@ paths:application/json:example:id: exp_gbHJdmfrXB- number: EF731744274+ number: EF329172445type: Spree::Exports::Productsformat: csv- created_at: '2026-06-01T13:01:01.772Z'- updated_at: '2026-06-01T13:01:01.772Z'+ created_at: '2026-06-05T13:12:05.895Z'+ updated_at: '2026-06-05T13:12:05.895Z'user_id: admin_UkLWZg9DAJdone: falsefilename:@@ -4190,11 +4186,11 @@ paths:application/json:example:id: exp_UkLWZg9DAJ- number: EF413757044+ number: EF518550027type: Spree::Exports::Productsformat: csv- created_at: '2026-06-01T13:01:02.046Z'- updated_at: '2026-06-01T13:01:02.046Z'+ created_at: '2026-06-05T13:12:06.180Z'+ updated_at: '2026-06-05T13:12:06.180Z'user_id: admin_UkLWZg9DAJdone: falsefilename:@@ -4377,8 +4373,8 @@ paths:codes_count: 2currency: USDprefix: WELCOME- created_at: '2026-06-01T13:01:02.646Z'- updated_at: '2026-06-01T13:01:02.646Z'+ created_at: '2026-06-05T13:12:06.832Z'+ updated_at: '2026-06-05T13:12:06.832Z'amount: '50.0'expires_at:created_by_id:@@ -4459,8 +4455,8 @@ paths:codes_count: 5currency: USDprefix: NEWCAMP- created_at: '2026-06-01T13:01:03.221Z'- updated_at: '2026-06-01T13:01:03.221Z'+ created_at: '2026-06-05T13:12:07.399Z'+ updated_at: '2026-06-05T13:12:07.399Z'amount: '25.0'expires_at: '2030-12-31'created_by_id: admin_UkLWZg9DAJ@@ -4561,8 +4557,8 @@ paths:codes_count: 2currency: USDprefix: WELCOME- created_at: '2026-06-01T13:01:03.515Z'- updated_at: '2026-06-01T13:01:03.515Z'+ created_at: '2026-06-05T13:12:07.697Z'+ updated_at: '2026-06-05T13:12:07.697Z'amount: '50.0'expires_at:created_by_id:@@ -4665,7 +4661,7 @@ paths:example:data:- id: gc_UkLWZg9DAJ- code: 53DCF9F59D80C8A1+ code: 6951A14B300CEC04status: activecurrency: USDamount: '50.0'@@ -4679,12 +4675,12 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-06-01T13:01:04.127Z'- updated_at: '2026-06-01T13:01:04.127Z'+ created_at: '2026-06-05T13:12:08.266Z'+ updated_at: '2026-06-05T13:12:08.266Z'customer_id:created_by_id:- id: gc_gbHJdmfrXB- code: 163BA2CB10DE4FAF+ code: 3E031B73A4AE32CDstatus: activecurrency: USDamount: '25.0'@@ -4698,8 +4694,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-06-01T13:01:04.130Z'- updated_at: '2026-06-01T13:01:04.130Z'+ created_at: '2026-06-05T13:12:08.267Z'+ updated_at: '2026-06-05T13:12:08.267Z'customer_id:created_by_id:meta:@@ -4784,7 +4780,7 @@ paths:application/json:example:id: gc_EfhxLZ9ck8- code: 2EA8C4D29684952A+ code: CC7C00B458CBFC8Fstatus: activecurrency: USDamount: '25.0'@@ -4798,8 +4794,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-06-01T13:01:04.753Z'- updated_at: '2026-06-01T13:01:04.753Z'+ created_at: '2026-06-05T13:12:08.868Z'+ updated_at: '2026-06-05T13:12:08.868Z'customer_id:created_by_id: admin_UkLWZg9DAJschema:@@ -4905,7 +4901,7 @@ paths:application/json:example:id: gc_UkLWZg9DAJ- code: EBAF5467FA1AFDB6+ code: A45E8E4B11DA9DBDstatus: activecurrency: USDamount: '50.0'@@ -4919,8 +4915,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-06-01T13:01:05.046Z'- updated_at: '2026-06-01T13:01:05.046Z'+ created_at: '2026-06-05T13:12:09.160Z'+ updated_at: '2026-06-05T13:12:09.160Z'customer_id:created_by_id:schema:@@ -4980,7 +4976,7 @@ paths:application/json:example:id: gc_UkLWZg9DAJ- code: 37CAF976A5C6E1E2+ code: E6E13513E44B8807status: activecurrency: USDamount: '75.0'@@ -4994,8 +4990,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-06-01T13:01:05.620Z'- updated_at: '2026-06-01T13:01:05.897Z'+ created_at: '2026-06-05T13:12:09.749Z'+ updated_at: '2026-06-05T13:12:10.070Z'customer_id:created_by_id:schema:@@ -5107,15 +5103,15 @@ paths:example:data:- id: inv_UkLWZg9DAJ- email: [email protected]+ email: [email protected]status: pending- created_at: '2026-06-01T13:01:06.738Z'- updated_at: '2026-06-01T13:01:06.738Z'- expires_at: '2026-06-15T13:01:06.736Z'+ created_at: '2026-06-05T13:12:10.949Z'+ updated_at: '2026-06-05T13:12:10.949Z'+ expires_at: '2026-06-19T13:12:10.946Z'role_id: role_UkLWZg9DAJrole_name: admin- inviter_email: [email protected]- acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=HxZc9HRnCkEx5idyM3ALMnpK"+ inviter_email: [email protected]+ acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=N3LaaRRjJKwDAC53Q7d7XQHE"invitee_exists: falsestore:id: store_UkLWZg9DAJ@@ -5176,13 +5172,13 @@ paths:id: inv_gbHJdmfrXBemail: [email protected]status: pending- created_at: '2026-06-01T13:01:07.038Z'- updated_at: '2026-06-01T13:01:07.038Z'- expires_at: '2026-06-15T13:01:07.035Z'+ created_at: '2026-06-05T13:12:11.261Z'+ updated_at: '2026-06-05T13:12:11.261Z'+ expires_at: '2026-06-19T13:12:11.258Z'role_id: role_UkLWZg9DAJrole_name: admin- inviter_email: [email protected]- acceptance_url: "/accept-invitation/inv_gbHJdmfrXB?token=z4cJh9MkusDHDHN1MMTzMKvd"+ inviter_email: [email protected]+ acceptance_url: "/accept-invitation/inv_gbHJdmfrXB?token=wYFYKSZ6g8os2yNZ47uq9AKt"invitee_exists: falsestore:id: store_UkLWZg9DAJ@@ -5289,15 +5285,15 @@ paths:application/json:example:id: inv_UkLWZg9DAJ- email: [email protected]+ email: [email protected]status: pending- created_at: '2026-06-01T13:01:07.599Z'- updated_at: '2026-06-01T13:01:07.599Z'- expires_at: '2026-06-15T13:01:07.597Z'+ created_at: '2026-06-05T13:12:11.821Z'+ updated_at: '2026-06-05T13:12:11.821Z'+ expires_at: '2026-06-19T13:12:11.819Z'role_id: role_UkLWZg9DAJrole_name: admin- inviter_email: [email protected]- acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=wy9piS9BULd4TKBTY8pW4Xfp"+ inviter_email: [email protected]+ acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=Yc4V21BzHSZrGdscgN1Nqty3"invitee_exists: falsestore:id: store_UkLWZg9DAJ@@ -5383,8 +5379,8 @@ paths:- DEsupported_locales:- en- created_at: '2026-06-01T13:01:07.652Z'- updated_at: '2026-06-01T13:01:07.652Z'+ created_at: '2026-06-05T13:12:11.873Z'+ updated_at: '2026-06-05T13:12:11.873Z'meta:page: 1limit: 25@@ -5474,8 +5470,8 @@ paths:supported_locales:- en- fr- created_at: '2026-06-01T13:01:08.237Z'- updated_at: '2026-06-01T13:01:08.237Z'+ created_at: '2026-06-05T13:12:12.481Z'+ updated_at: '2026-06-05T13:12:12.481Z'schema:"$ref": "#/components/schemas/Market"'422':@@ -5608,8 +5604,8 @@ paths:- DEsupported_locales:- en- created_at: '2026-06-01T13:01:08.578Z'- updated_at: '2026-06-01T13:01:08.578Z'+ created_at: '2026-06-05T13:12:12.806Z'+ updated_at: '2026-06-05T13:12:12.806Z'schema:"$ref": "#/components/schemas/Market"'404':@@ -5685,8 +5681,8 @@ paths:- DEsupported_locales:- en- created_at: '2026-06-01T13:01:09.195Z'- updated_at: '2026-06-01T13:01:09.495Z'+ created_at: '2026-06-05T13:12:13.407Z'+ updated_at: '2026-06-05T13:12:13.691Z'schema:"$ref": "#/components/schemas/Market"'422':@@ -5823,12 +5819,12 @@ paths:example:user:id: admin_UkLWZg9DAJ- email: [email protected]- first_name: Beulah- last_name: McCullough- full_name: Beulah McCullough- created_at: '2026-06-01T13:01:10.673Z'- updated_at: '2026-06-01T13:01:10.673Z'+ email: [email protected]+ first_name: Contessa+ last_name: Wilkinson+ full_name: Contessa Wilkinson+ created_at: '2026-06-05T13:12:14.933Z'+ updated_at: '2026-06-05T13:12:14.933Z'roles:- id: role_UkLWZg9DAJname: admin@@ -5978,8 +5974,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-06-01T13:01:10.710Z'- updated_at: '2026-06-01T13:01:10.710Z'+ created_at: '2026-06-05T13:12:14.971Z'+ updated_at: '2026-06-05T13:12:14.971Z'meta:page: 1limit: 25@@ -6070,8 +6066,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-06-01T13:01:11.278Z'- updated_at: '2026-06-01T13:01:11.278Z'+ created_at: '2026-06-05T13:12:15.556Z'+ updated_at: '2026-06-05T13:12:15.556Z'schema:"$ref": "#/components/schemas/OptionType"'422':@@ -6192,8 +6188,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-06-01T13:01:11.561Z'- updated_at: '2026-06-01T13:01:11.561Z'+ created_at: '2026-06-05T13:12:15.850Z'+ updated_at: '2026-06-05T13:12:15.850Z'schema:"$ref": "#/components/schemas/OptionType"'404':@@ -6265,8 +6261,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-06-01T13:01:12.132Z'- updated_at: '2026-06-01T13:01:12.408Z'+ created_at: '2026-06-05T13:12:16.438Z'+ updated_at: '2026-06-05T13:12:16.733Z'schema:"$ref": "#/components/schemas/OptionType"'422':@@ -6425,7 +6421,7 @@ paths:example:data:- id: ful_UkLWZg9DAJ- number: H36845303120+ number: H66206934403tracking: U10000tracking_url:cost: '10.0'@@ -6450,8 +6446,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:13.304Z'- updated_at: '2026-06-01T13:01:13.376Z'+ created_at: '2026-06-05T13:12:17.678Z'+ updated_at: '2026-06-05T13:12:17.764Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJmeta:@@ -6534,7 +6530,7 @@ paths:application/json:example:id: ful_UkLWZg9DAJ- number: H15674195568+ number: H71788811584tracking: U10000tracking_url:cost: '10.0'@@ -6559,8 +6555,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:13.976Z'- updated_at: '2026-06-01T13:01:14.027Z'+ created_at: '2026-06-05T13:12:18.394Z'+ updated_at: '2026-06-05T13:12:18.461Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJpatch:@@ -6619,7 +6615,7 @@ paths:application/json:example:id: ful_UkLWZg9DAJ- number: H06870225960+ number: H67296446384tracking: 1Z999AA10123456784tracking_url: https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z999AA10123456784cost: '10.0'@@ -6644,8 +6640,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:14.635Z'- updated_at: '2026-06-01T13:01:14.971Z'+ created_at: '2026-06-05T13:12:19.053Z'+ updated_at: '2026-06-05T13:12:19.401Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJrequestBody:@@ -6714,7 +6710,7 @@ paths:application/json:example:id: ful_UkLWZg9DAJ- number: H16323249562+ number: H69393047882tracking: U10000tracking_url:cost: '10.0'@@ -6731,7 +6727,7 @@ paths:display_tax_total: "$0.00"status: shippedfulfillment_type: shipping- fulfilled_at: '2026-06-01T13:01:15Z'+ fulfilled_at: '2026-06-05T13:12:20Z'items:- item_id: li_UkLWZg9DAJvariant_id: variant_UkLWZg9DAJ@@ -6739,8 +6735,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:15.284Z'- updated_at: '2026-06-01T13:01:15.661Z'+ created_at: '2026-06-05T13:12:19.753Z'+ updated_at: '2026-06-05T13:12:20.121Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJ"/api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel":@@ -6798,7 +6794,7 @@ paths:application/json:example:id: ful_UkLWZg9DAJ- number: H59455109975+ number: H10254297058tracking: U10000tracking_url:cost: '10.0'@@ -6823,8 +6819,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:16.028Z'- updated_at: '2026-06-01T13:01:16.365Z'+ created_at: '2026-06-05T13:12:20.465Z'+ updated_at: '2026-06-05T13:12:20.820Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJ"/api/v3/admin/orders/{order_id}/fulfillments/{id}/resume":@@ -6882,7 +6878,7 @@ paths:application/json:example:id: ful_UkLWZg9DAJ- number: H60046176880+ number: H16692131444tracking: U10000tracking_url:cost: '10.0'@@ -6907,8 +6903,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:16.693Z'- updated_at: '2026-06-01T13:01:17.032Z'+ created_at: '2026-06-05T13:12:21.205Z'+ updated_at: '2026-06-05T13:12:21.558Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJ"/api/v3/admin/orders/{order_id}/fulfillments/{id}/split":@@ -6969,7 +6965,7 @@ paths:example:data:- id: ful_gbHJdmfrXB- number: H78191710167+ number: H35539389110tracking:tracking_url:cost: '10.0'@@ -6994,8 +6990,8 @@ paths:metadata: {}adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-06-01T13:01:17.704Z'- updated_at: '2026-06-01T13:01:17.744Z'+ created_at: '2026-06-05T13:12:22.230Z'+ updated_at: '2026-06-05T13:12:22.284Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_gbHJdmfrXBrequestBody:@@ -7067,7 +7063,7 @@ paths:application/json:example:id: gc_UkLWZg9DAJ- code: E8C8BC7252E9CCDE+ code: 0F23E851245D7551status: activecurrency: USDamount: '10.0'@@ -7081,8 +7077,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-06-01T13:01:18.076Z'- updated_at: '2026-06-01T13:01:18.367Z'+ created_at: '2026-06-05T13:12:22.652Z'+ updated_at: '2026-06-05T13:12:22.951Z'customer_id:created_by_id:requestBody:@@ -7215,8 +7211,8 @@ paths:variant_id: variant_gbHJdmfrXBquantity: 2currency: USD- name: Product 129181- slug: product-129181+ name: Product 123949+ slug: product-123949options_text: 'Size: S'price: '10.0'display_price: "$10.00"@@ -7248,12 +7244,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:01:19.041Z'- updated_at: '2026-06-01T13:01:19.041Z'+ created_at: '2026-06-05T13:12:23.640Z'+ updated_at: '2026-06-05T13:12:23.640Z'digital_links: []metadata: {}- created_at: '2026-06-01T13:01:19.327Z'- updated_at: '2026-06-01T13:01:19.327Z'+ created_at: '2026-06-05T13:12:23.928Z'+ updated_at: '2026-06-05T13:12:23.928Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJmeta:@@ -7320,8 +7316,8 @@ paths:variant_id: variant_VqXmZF31wYquantity: 3currency: USD- name: Product 148217- slug: product-148217+ name: Product 146023+ slug: product-146023options_text: 'Size: S'price: '19.99'display_price: "$19.99"@@ -7353,12 +7349,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:01:20.230Z'- updated_at: '2026-06-01T13:01:20.230Z'+ created_at: '2026-06-05T13:12:24.866Z'+ updated_at: '2026-06-05T13:12:24.866Z'digital_links: []metadata: {}- created_at: '2026-06-01T13:01:20.263Z'- updated_at: '2026-06-01T13:01:20.263Z'+ created_at: '2026-06-05T13:12:24.902Z'+ updated_at: '2026-06-05T13:12:24.902Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJrequestBody:@@ -7447,8 +7443,8 @@ paths:variant_id: variant_gbHJdmfrXBquantity: 2currency: USD- name: Product 156451- slug: product-156451+ name: Product 154567+ slug: product-154567options_text: 'Size: S'price: '10.0'display_price: "$10.00"@@ -7480,12 +7476,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:01:20.326Z'- updated_at: '2026-06-01T13:01:20.326Z'+ created_at: '2026-06-05T13:12:24.995Z'+ updated_at: '2026-06-05T13:12:24.995Z'digital_links: []metadata: {}- created_at: '2026-06-01T13:01:20.611Z'- updated_at: '2026-06-01T13:01:20.611Z'+ created_at: '2026-06-05T13:12:25.281Z'+ updated_at: '2026-06-05T13:12:25.281Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJpatch:@@ -7547,8 +7543,8 @@ paths:variant_id: variant_gbHJdmfrXBquantity: 5currency: USD- name: Product 162178- slug: product-162178+ name: Product 163612+ slug: product-163612options_text: 'Size: S'price: '19.99'display_price: "$19.99"@@ -7580,12 +7576,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:01:20.937Z'- updated_at: '2026-06-01T13:01:20.937Z'+ created_at: '2026-06-05T13:12:25.675Z'+ updated_at: '2026-06-05T13:12:25.675Z'digital_links: []metadata: {}- created_at: '2026-06-01T13:01:21.226Z'- updated_at: '2026-06-01T13:01:21.521Z'+ created_at: '2026-06-05T13:12:25.974Z'+ updated_at: '2026-06-05T13:12:26.297Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJrequestBody:@@ -7711,8 +7707,8 @@ paths:data:- id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: BGS-7c44a62352e2- number: P46G67TO+ response_code: BGS-610e4508ff71+ number: PA2ZJ1PNamount: '110.0'display_amount: "$110.00"status: completed@@ -7730,14 +7726,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-06-01T13:01:22.530Z'- updated_at: '2026-06-01T13:01:22.534Z'+ created_at: '2026-06-05T13:12:27.286Z'+ updated_at: '2026-06-05T13:12:27.289Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-06-01T13:01:22.532Z'- updated_at: '2026-06-01T13:01:22.532Z'+ created_at: '2026-06-05T13:12:27.288Z'+ updated_at: '2026-06-05T13:12:27.288Z'captured_amount: '0.0'order_id: or_UkLWZg9DAJmeta:@@ -7804,7 +7800,7 @@ paths:id: py_gbHJdmfrXBpayment_method_id: pm_EfhxLZ9ck8response_code:- number: P4N1W6NO+ number: PXM5FBY9amount: '110.0'display_amount: "$110.00"status: checkout@@ -7815,8 +7811,8 @@ paths:avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-06-01T13:01:23.839Z'- updated_at: '2026-06-01T13:01:23.839Z'+ created_at: '2026-06-05T13:12:28.585Z'+ updated_at: '2026-06-05T13:12:28.585Z'captured_amount: '0.0'order_id: or_gbHJdmfrXBrequestBody:@@ -7906,8 +7902,8 @@ paths:example:id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: BGS-0048984b58f5- number: PXPDOS9F+ response_code: BGS-30f317a77b37+ number: P02PKLSPamount: '110.0'display_amount: "$110.00"status: completed@@ -7925,14 +7921,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-06-01T13:01:24.203Z'- updated_at: '2026-06-01T13:01:24.205Z'+ created_at: '2026-06-05T13:12:28.956Z'+ updated_at: '2026-06-05T13:12:28.958Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-06-01T13:01:24.205Z'- updated_at: '2026-06-01T13:01:24.205Z'+ created_at: '2026-06-05T13:12:28.957Z'+ updated_at: '2026-06-05T13:12:28.957Z'captured_amount: '0.0'order_id: or_UkLWZg9DAJ"/api/v3/admin/orders/{order_id}/payments/{id}/capture":@@ -7991,8 +7987,8 @@ paths:example:id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: BGS-ed0d2b701871- number: PST174P8+ response_code: BGS-8274fb792a75+ number: PACXCPQHamount: '110.0'display_amount: "$110.00"status: completed@@ -8010,14 +8006,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-06-01T13:01:24.855Z'- updated_at: '2026-06-01T13:01:24.858Z'+ created_at: '2026-06-05T13:12:29.611Z'+ updated_at: '2026-06-05T13:12:29.614Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-06-01T13:01:24.857Z'- updated_at: '2026-06-01T13:01:25.175Z'+ created_at: '2026-06-05T13:12:29.613Z'+ updated_at: '2026-06-05T13:12:29.973Z'captured_amount: '110.0'order_id: or_UkLWZg9DAJ'422':@@ -8086,8 +8082,8 @@ paths:example:id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: void-BGS-d3692bdee3ff- number: PCO5JT8F+ response_code: void-BGS-c5cdfced60ed+ number: PX8LJ7IHamount: '110.0'display_amount: "$110.00"status: void@@ -8105,14 +8101,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-06-01T13:01:26.223Z'- updated_at: '2026-06-01T13:01:26.225Z'+ created_at: '2026-06-05T13:12:31.062Z'+ updated_at: '2026-06-05T13:12:31.065Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-06-01T13:01:26.224Z'- updated_at: '2026-06-01T13:01:26.517Z'+ created_at: '2026-06-05T13:12:31.064Z'+ updated_at: '2026-06-05T13:12:31.376Z'captured_amount: '0.0'order_id: or_UkLWZg9DAJ"/api/v3/admin/orders/{order_id}/refunds":@@ -8240,14 +8236,14 @@ paths:application/json:example:id: re_UkLWZg9DAJ- transaction_id: BGS-ba3bda981ad7+ transaction_id: BGS-fc6b3e38ec30amount: '5.0'payment_id: py_UkLWZg9DAJrefund_reason_id: rr_UkLWZg9DAJreimbursement_id:metadata: {}- created_at: '2026-06-01T13:01:27.827Z'- updated_at: '2026-06-01T13:01:27.827Z'+ created_at: '2026-06-05T13:12:32.755Z'+ updated_at: '2026-06-05T13:12:32.755Z'requestBody:content:application/json:@@ -8319,8 +8315,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R755664082- email: [email protected]+ number: R368133355+ email: [email protected]customer_note:currency: USDlocale: en@@ -8363,8 +8359,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:28.120Z'- updated_at: '2026-06-01T13:01:28.166Z'+ created_at: '2026-06-05T13:12:33.082Z'+ updated_at: '2026-06-05T13:12:33.137Z'preferred_stock_location_id:tags: []internal_note:@@ -8535,8 +8531,8 @@ paths:- id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R337863999- email: [email protected]+ number: R114520773+ email: [email protected]customer_note:currency: USDlocale: en@@ -8579,8 +8575,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:29.893Z'- updated_at: '2026-06-01T13:01:29.893Z'+ created_at: '2026-06-05T13:12:34.902Z'+ updated_at: '2026-06-05T13:12:34.902Z'preferred_stock_location_id:tags: []internal_note:@@ -8723,7 +8719,7 @@ paths:id: or_gbHJdmfrXBmarket_id:channel_id: ch_UkLWZg9DAJ- number: R050278809+ number: R773205198email: [email protected]customer_note:currency: USD@@ -8767,8 +8763,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:31.558Z'- updated_at: '2026-06-01T13:01:31.561Z'+ created_at: '2026-06-05T13:12:36.601Z'+ updated_at: '2026-06-05T13:12:36.605Z'preferred_stock_location_id: sloc_UkLWZg9DAJtags: []internal_note:@@ -8952,8 +8948,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R541744000- email: [email protected]+ number: R639530153+ email: [email protected]customer_note:currency: USDlocale: en@@ -8996,8 +8992,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:31.834Z'- updated_at: '2026-06-01T13:01:31.834Z'+ created_at: '2026-06-05T13:12:36.884Z'+ updated_at: '2026-06-05T13:12:36.884Z'preferred_stock_location_id:tags: []internal_note:@@ -9068,7 +9064,7 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R325856708+ number: R770729281email: [email protected]customer_note:currency: USD@@ -9112,8 +9108,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:32.930Z'- updated_at: '2026-06-01T13:01:33.212Z'+ created_at: '2026-06-05T13:12:37.996Z'+ updated_at: '2026-06-05T13:12:38.281Z'preferred_stock_location_id:tags: []internal_note:@@ -9294,8 +9290,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R317581508- email: [email protected]+ number: R150931097+ email: [email protected]customer_note:currency: USDlocale: en@@ -9322,7 +9318,7 @@ paths:display_delivery_total: "$100.00"fulfillment_status: readypayment_status: paid- completed_at: '2026-06-01T13:01:34.182Z'+ completed_at: '2026-06-05T13:12:39.240Z'store_credit_total: '0.0'display_store_credit_total: "$0.00"covered_by_store_credit: false@@ -9338,8 +9334,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:34.085Z'- updated_at: '2026-06-01T13:01:34.208Z'+ created_at: '2026-06-05T13:12:39.156Z'+ updated_at: '2026-06-05T13:12:39.289Z'preferred_stock_location_id:tags: []internal_note:@@ -9420,8 +9416,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R774529601- email: [email protected]+ number: R477684328+ email: [email protected]customer_note:currency: USDlocale: en@@ -9448,7 +9444,7 @@ paths:display_delivery_total: "$10.00"fulfillment_status: canceledpayment_status: void- completed_at: '2026-06-01T13:01:35.432Z'+ completed_at: '2026-06-05T13:12:40.644Z'store_credit_total: '0.0'display_store_credit_total: "$0.00"covered_by_store_credit: false@@ -9462,10 +9458,10 @@ paths:payment_total: '0.0'display_payment_total: "$0.00"metadata: {}- canceled_at: '2026-06-01T13:01:35.716Z'+ canceled_at: '2026-06-05T13:12:40.934Z'approved_at:- created_at: '2026-06-01T13:01:35.382Z'- updated_at: '2026-06-01T13:01:35.750Z'+ created_at: '2026-06-05T13:12:40.589Z'+ updated_at: '2026-06-05T13:12:40.972Z'preferred_stock_location_id:tags: []internal_note:@@ -9524,8 +9520,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R367952881- email: [email protected]+ number: R292529403+ email: [email protected]customer_note:currency: USDlocale: en@@ -9552,7 +9548,7 @@ paths:display_delivery_total: "$100.00"fulfillment_status:payment_status:- completed_at: '2026-06-01T13:01:36.136Z'+ completed_at: '2026-06-05T13:12:41.327Z'store_credit_total: '0.0'display_store_credit_total: "$0.00"covered_by_store_credit: false@@ -9567,9 +9563,9 @@ paths:display_payment_total: "$0.00"metadata: {}canceled_at:- approved_at: '2026-06-01T13:01:36.423Z'- created_at: '2026-06-01T13:01:36.077Z'- updated_at: '2026-06-01T13:01:36.136Z'+ approved_at: '2026-06-05T13:12:41.625Z'+ created_at: '2026-06-05T13:12:41.271Z'+ updated_at: '2026-06-05T13:12:41.327Z'preferred_stock_location_id:tags: []internal_note:@@ -9628,8 +9624,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R309537030- email: [email protected]+ number: R684756853+ email: [email protected]customer_note:currency: USDlocale: en@@ -9656,7 +9652,7 @@ paths:display_delivery_total: "$10.00"fulfillment_status: canceledpayment_status: void- completed_at: '2026-06-01T13:01:36.750Z'+ completed_at: '2026-06-05T13:12:41.987Z'store_credit_total: '0.0'display_store_credit_total: "$0.00"covered_by_store_credit: false@@ -9670,10 +9666,10 @@ paths:payment_total: '0.0'display_payment_total: "$0.00"metadata: {}- canceled_at: '2026-06-01T13:01:37.023Z'+ canceled_at: '2026-06-05T13:12:42.318Z'approved_at:- created_at: '2026-06-01T13:01:36.703Z'- updated_at: '2026-06-01T13:01:37.098Z'+ created_at: '2026-06-05T13:12:41.911Z'+ updated_at: '2026-06-05T13:12:42.409Z'preferred_stock_location_id:tags: []internal_note:@@ -9732,8 +9728,8 @@ paths:id: or_UkLWZg9DAJmarket_id:channel_id: ch_UkLWZg9DAJ- number: R545331159- email: [email protected]+ number: R815365085+ email: [email protected]customer_note:currency: USDlocale: en@@ -9760,7 +9756,7 @@ paths:display_delivery_total: "$100.00"fulfillment_status:payment_status:- completed_at: '2026-06-01T13:01:37.424Z'+ completed_at: '2026-06-05T13:12:42.746Z'store_credit_total: '0.0'display_store_credit_total: "$0.00"covered_by_store_credit: false@@ -9776,8 +9772,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-06-01T13:01:37.376Z'- updated_at: '2026-06-01T13:01:37.424Z'+ created_at: '2026-06-05T13:12:42.695Z'+ updated_at: '2026-06-05T13:12:42.746Z'preferred_stock_location_id:tags: []internal_note:@@ -9852,8 +9848,8 @@ paths:auto_capture:storefront_visible: trueposition: 1- created_at: '2026-06-01T13:01:37.719Z'- updated_at: '2026-06-01T13:01:37.720Z'+ created_at: '2026-06-05T13:12:43.046Z'+ updated_at: '2026-06-05T13:12:43.047Z'preferences: {}preference_schema: []meta:@@ -9993,8 +9989,8 @@ paths:auto_capture:storefront_visible: trueposition: 1- created_at: '2026-06-01T13:01:38.307Z'- updated_at: '2026-06-01T13:01:38.308Z'+ created_at: '2026-06-05T13:12:43.637Z'+ updated_at: '2026-06-05T13:12:43.638Z'preferences: {}preference_schema: []"/api/v3/admin/price_lists":@@ -10067,8 +10063,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:38.592Z'- updated_at: '2026-06-01T13:01:38.592Z'+ created_at: '2026-06-05T13:12:43.927Z'+ updated_at: '2026-06-05T13:12:43.927Z'currently_active: falseproducts_count: 0prices_count: 0@@ -10082,8 +10078,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:38.593Z'- updated_at: '2026-06-01T13:01:38.593Z'+ created_at: '2026-06-05T13:12:43.928Z'+ updated_at: '2026-06-05T13:12:43.928Z'currently_active: falseproducts_count: 0prices_count: 0@@ -10147,8 +10143,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:39.545Z'- updated_at: '2026-06-01T13:01:39.547Z'+ created_at: '2026-06-05T13:12:44.932Z'+ updated_at: '2026-06-05T13:12:44.934Z'currently_active: falseproducts_count: 1prices_count: 2@@ -10296,8 +10292,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:39.836Z'- updated_at: '2026-06-01T13:01:39.836Z'+ created_at: '2026-06-05T13:12:45.249Z'+ updated_at: '2026-06-05T13:12:45.249Z'currently_active: falseproducts_count: 0prices_count: 0@@ -10355,8 +10351,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:41.376Z'- updated_at: '2026-06-01T13:01:41.650Z'+ created_at: '2026-06-05T13:12:46.832Z'+ updated_at: '2026-06-05T13:12:47.116Z'currently_active: falseproducts_count: 0prices_count: 0@@ -10514,8 +10510,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:41.938Z'- updated_at: '2026-06-01T13:01:42.212Z'+ created_at: '2026-06-05T13:12:47.414Z'+ updated_at: '2026-06-05T13:12:47.693Z'currently_active: trueproducts_count: 0prices_count: 0@@ -10563,8 +10559,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-06-01T13:01:42.227Z'- updated_at: '2026-06-01T13:01:42.517Z'+ created_at: '2026-06-05T13:12:47.702Z'+ updated_at: '2026-06-05T13:12:47.980Z'currently_active: falseproducts_count: 0prices_count: 0@@ -10675,8 +10671,8 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_gbHJdmfrXB- created_at: '2026-06-01T13:01:42.627Z'- updated_at: '2026-06-01T13:01:42.627Z'+ created_at: '2026-06-05T13:12:48.033Z'+ updated_at: '2026-06-05T13:12:48.033Z'- id: price_EfhxLZ9ck8amount: '5.0'amount_in_cents: 500@@ -10687,8 +10683,8 @@ paths:display_compare_at_amount:price_list_id: pl_UkLWZg9DAJvariant_id: variant_gbHJdmfrXB- created_at: '2026-06-01T13:01:42.634Z'- updated_at: '2026-06-01T13:01:42.634Z'+ created_at: '2026-06-05T13:12:48.037Z'+ updated_at: '2026-06-05T13:12:48.037Z'meta:page: 1limit: 25@@ -10767,8 +10763,8 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_EfhxLZ9ck8- created_at: '2026-06-01T13:01:43.273Z'- updated_at: '2026-06-01T13:01:43.273Z'+ created_at: '2026-06-05T13:12:48.724Z'+ updated_at: '2026-06-05T13:12:48.724Z'schema:"$ref": "#/components/schemas/Price"requestBody:@@ -10852,8 +10848,8 @@ paths:display_compare_at_amount:price_list_id: pl_UkLWZg9DAJvariant_id: variant_gbHJdmfrXB- created_at: '2026-06-01T13:01:43.336Z'- updated_at: '2026-06-01T13:01:43.336Z'+ created_at: '2026-06-05T13:12:48.822Z'+ updated_at: '2026-06-05T13:12:48.822Z'schema:"$ref": "#/components/schemas/Price"'404':@@ -10915,8 +10911,8 @@ paths:display_compare_at_amount:price_list_id: pl_UkLWZg9DAJvariant_id: variant_gbHJdmfrXB- created_at: '2026-06-01T13:01:43.996Z'- updated_at: '2026-06-01T13:01:44.274Z'+ created_at: '2026-06-05T13:12:49.490Z'+ updated_at: '2026-06-05T13:12:49.771Z'schema:"$ref": "#/components/schemas/Price"requestBody:@@ -11216,8 +11212,8 @@ paths:field_type: short_textkey: custom.titlevalue: wool- created_at: '2026-06-01T13:01:45.680Z'- updated_at: '2026-06-01T13:01:45.680Z'+ created_at: '2026-06-05T13:12:51.254Z'+ updated_at: '2026-06-05T13:12:51.254Z'storefront_visible: truecustom_field_definition_id: cfdef_UkLWZg9DAJmeta:@@ -11284,8 +11280,8 @@ paths:field_type: long_textkey: custom.descriptionvalue: A longer description- created_at: '2026-06-01T13:01:46.275Z'- updated_at: '2026-06-01T13:01:46.275Z'+ created_at: '2026-06-05T13:12:51.866Z'+ updated_at: '2026-06-05T13:12:51.866Z'storefront_visible: truecustom_field_definition_id: cfdef_gbHJdmfrXB'422':@@ -11369,8 +11365,8 @@ paths:field_type: short_textkey: custom.titlevalue: wool- created_at: '2026-06-01T13:01:46.627Z'- updated_at: '2026-06-01T13:01:46.627Z'+ created_at: '2026-06-05T13:12:52.251Z'+ updated_at: '2026-06-05T13:12:52.251Z'storefront_visible: truecustom_field_definition_id: cfdef_UkLWZg9DAJpatch:@@ -11417,8 +11413,8 @@ paths:field_type: short_textkey: custom.titlevalue: cotton- created_at: '2026-06-01T13:01:46.936Z'- updated_at: '2026-06-01T13:01:47.210Z'+ created_at: '2026-06-05T13:12:52.572Z'+ updated_at: '2026-06-05T13:12:52.858Z'storefront_visible: truecustom_field_definition_id: cfdef_UkLWZg9DAJrequestBody:@@ -11556,8 +11552,8 @@ paths:example:data:- id: prod_UkLWZg9DAJ- name: Product 578910- slug: product-578910+ name: Product 574995+ slug: product-574995meta_title:meta_description:meta_keywords:@@ -11567,20 +11563,19 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Dignissimos nostrum doloremque nisi voluptate. Dolore- voluptas cum rerum praesentium vitae. Error iste possimus voluptas- accusantium exercitationem sunt molestiae sequi. Modi nemo consectetur- fugit assumenda. Atque exercitationem veritatis nesciunt corporis.- Voluptas culpa placeat voluptate quo quae vero reiciendis. Qui- illo autem ipsa molestias delectus culpa. Laboriosam dolorum provident- quas consectetur libero aut dolore fuga. Dolor quibusdam omnis- aspernatur exercitationem. Rem quisquam blanditiis odit sed quae- qui doloremque modi. Quisquam sunt reprehenderit fuga quibusdam- veniam amet inventore.+ description: Exercitationem necessitatibus eaque perspiciatis voluptates+ dolore. Non fugiat alias saepe possimus cum atque velit itaque.+ Id quod eos eius possimus. Quis id reiciendis numquam voluptatibus.+ Similique nisi quod omnis optio quaerat tempore commodi. Dolorum+ officia labore architecto laudantium magnam eligendi a quis. Praesentium+ minus facere voluptates a magni repellat. Quo neque necessitatibus+ autem nostrum laboriosam. Excepturi aspernatur commodi amet voluptatum+ doloribus. Tempore itaque numquam nihil corrupti eum veniam. Soluta+ minus temporibus laboriosam facere sit itaque.description_html: |-- Dignissimos nostrum doloremque nisi voluptate. Dolore voluptas cum rerum praesentium vitae. Error iste possimus voluptas accusantium exercitationem sunt molestiae sequi. Modi nemo consectetur fugit assumenda.- Atque exercitationem veritatis nesciunt corporis. Voluptas culpa placeat voluptate quo quae vero reiciendis. Qui illo autem ipsa molestias delectus culpa.- Laboriosam dolorum provident quas consectetur libero aut dolore fuga. Dolor quibusdam omnis aspernatur exercitationem. Rem quisquam blanditiis odit sed quae qui doloremque modi. Quisquam sunt reprehenderit fuga quibusdam veniam amet inventore.+ Exercitationem necessitatibus eaque perspiciatis voluptates dolore. Non fugiat alias saepe possimus cum atque velit itaque. Id quod eos eius possimus. Quis id reiciendis numquam voluptatibus.+ Similique nisi quod omnis optio quaerat tempore commodi. Dolorum officia labore architecto laudantium magnam eligendi a quis. Praesentium minus facere voluptates a magni repellat. Quo neque necessitatibus autem nostrum laboriosam.+ Excepturi aspernatur commodi amet voluptatum doloribus. Tempore itaque numquam nihil corrupti eum veniam. Soluta minus temporibus laboriosam facere sit itaque.default_variant_id: variant_UkLWZg9DAJthumbnail_url:tags: []@@ -11595,14 +11590,14 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-06-01T13:01:47.552Z'- updated_at: '2026-06-01T13:01:47.552Z'+ created_at: '2026-06-05T13:12:53.204Z'+ updated_at: '2026-06-05T13:12:53.204Z'original_price:status: activemetadata: {}deleted_at:- created_at: '2026-06-01T13:01:47.539Z'- updated_at: '2026-06-01T13:01:47.553Z'+ created_at: '2026-06-05T13:12:53.193Z'+ updated_at: '2026-06-05T13:12:53.211Z'tax_category_id: taxcat_UkLWZg9DAJmeta:page: 1@@ -11734,8 +11729,8 @@ paths:status: draftmetadata: {}deleted_at:- created_at: '2026-06-01T13:01:48.203Z'- updated_at: '2026-06-01T13:01:48.205Z'+ created_at: '2026-06-05T13:12:53.859Z'+ updated_at: '2026-06-05T13:12:53.860Z'tax_category_id:schema:"$ref": "#/components/schemas/Product"@@ -11915,8 +11910,8 @@ paths:application/json:example:id: prod_UkLWZg9DAJ- name: Product 614941- slug: product-614941+ name: Product 613292+ slug: product-613292meta_title:meta_description:meta_keywords:@@ -11926,31 +11921,25 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Cupiditate laboriosam suscipit dolorem corrupti delectus- pariatur. Animi qui exercitationem aut at explicabo libero. Assumenda- accusantium ratione error ducimus. Excepturi temporibus voluptatibus- dignissimos occaecati. Reprehenderit laborum accusantium reiciendis- aliquam. Harum perferendis eveniet veritatis debitis atque magni- laborum. Debitis tempore fuga nulla adipisci et sit. Quibusdam necessitatibus- sunt voluptatem eligendi iure. Eligendi temporibus placeat quaerat- dolor mollitia illo eius. Omnis laborum est illum commodi provident.- Excepturi repudiandae pariatur hic maiores iusto at natus. Rerum- asperiores eum corporis modi consequuntur ex. Facere commodi fugit- fugiat ullam ducimus assumenda animi iste. Dolores odit ipsum unde- cupiditate fuga quibusdam vero commodi. Quidem sequi ullam architecto- modi expedita. Aperiam hic animi a possimus laborum accusantium.- Maxime velit cum est at voluptatibus numquam deleniti. Minus voluptas- aspernatur nam non pariatur alias magnam. Consequatur consequuntur- nesciunt eligendi asperiores incidunt velit. Suscipit mollitia ducimus- corporis at dolorum excepturi. Repellat animi pariatur alias delectus- excepturi quos culpa dolore. Est voluptates id saepe iusto quas- illum nam.+ description: Corrupti incidunt recusandae tenetur impedit asperiores+ in culpa error. Ea quod incidunt inventore reiciendis molestiae+ error voluptatem. Assumenda sint adipisci odit et quisquam dicta+ nemo. Quas expedita voluptatem corrupti facere harum porro. Quia+ cumque natus inventore quam odit. Sint amet eum inventore quae soluta+ maxime. At excepturi placeat ipsum harum quo nemo. Voluptate ullam+ officiis iste aut. Ex fuga similique id commodi dolorem. Placeat+ dolor quasi consequatur iste nesciunt voluptatem. Omnis aspernatur+ consequatur aperiam est sequi. Officia vel nesciunt quaerat delectus.+ Laboriosam quis itaque debitis deserunt. Sed nesciunt occaecati+ veniam voluptas voluptatem nostrum architecto. Dolores in temporibus+ earum culpa. Fugit a eum natus odio libero. Doloribus dolor animi+ explicabo ullam sunt accusamus ipsa assumenda. Cum suscipit magnam+ expedita dolorum unde dicta odio.description_html: |-- Cupiditate laboriosam suscipit dolorem corrupti delectus pariatur. Animi qui exercitationem aut at explicabo libero. Assumenda accusantium ratione error ducimus. Excepturi temporibus voluptatibus dignissimos occaecati. Reprehenderit laborum accusantium reiciendis aliquam.- Harum perferendis eveniet veritatis debitis atque magni laborum. Debitis tempore fuga nulla adipisci et sit. Quibusdam necessitatibus sunt voluptatem eligendi iure. Eligendi temporibus placeat quaerat dolor mollitia illo eius.- Omnis laborum est illum commodi provident. Excepturi repudiandae pariatur hic maiores iusto at natus. Rerum asperiores eum corporis modi consequuntur ex. Facere commodi fugit fugiat ullam ducimus assumenda animi iste.- Dolores odit ipsum unde cupiditate fuga quibusdam vero commodi. Quidem sequi ullam architecto modi expedita. Aperiam hic animi a possimus laborum accusantium. Maxime velit cum est at voluptatibus numquam deleniti.- Minus voluptas aspernatur nam non pariatur alias magnam. Consequatur consequuntur nesciunt eligendi asperiores incidunt velit. Suscipit mollitia ducimus corporis at dolorum excepturi. Repellat animi pariatur alias delectus excepturi quos culpa dolore. Est voluptates id saepe iusto quas illum nam.+ Corrupti incidunt recusandae tenetur impedit asperiores in culpa error. Ea quod incidunt inventore reiciendis molestiae error voluptatem. Assumenda sint adipisci odit et quisquam dicta nemo. Quas expedita voluptatem corrupti facere harum porro. Quia cumque natus inventore quam odit.+ Sint amet eum inventore quae soluta maxime. At excepturi placeat ipsum harum quo nemo. Voluptate ullam officiis iste aut. Ex fuga similique id commodi dolorem. Placeat dolor quasi consequatur iste nesciunt voluptatem.+ Omnis aspernatur consequatur aperiam est sequi. Officia vel nesciunt quaerat delectus. Laboriosam quis itaque debitis deserunt. Sed nesciunt occaecati veniam voluptas voluptatem nostrum architecto.+ Dolores in temporibus earum culpa. Fugit a eum natus odio libero. Doloribus dolor animi explicabo ullam sunt accusamus ipsa assumenda. Cum suscipit magnam expedita dolorum unde dicta odio.default_variant_id: variant_UkLWZg9DAJthumbnail_url:tags: []@@ -11965,14 +11954,14 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-06-01T13:01:48.588Z'- updated_at: '2026-06-01T13:01:48.588Z'+ created_at: '2026-06-05T13:12:54.236Z'+ updated_at: '2026-06-05T13:12:54.236Z'original_price:status: activemetadata: {}deleted_at:- created_at: '2026-06-01T13:01:48.577Z'- updated_at: '2026-06-01T13:01:48.589Z'+ created_at: '2026-06-05T13:12:54.226Z'+ updated_at: '2026-06-05T13:12:54.241Z'tax_category_id: taxcat_UkLWZg9DAJschema:"$ref": "#/components/schemas/Product"@@ -12039,7 +12028,7 @@ paths:example:id: prod_UkLWZg9DAJname: Updated Name- slug: product-633426+ slug: product-632707meta_title:meta_description:meta_keywords:@@ -12049,25 +12038,21 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Molestias eveniet quibusdam suscipit odit. Accusamus- quo cumque officia necessitatibus libero repudiandae facilis explicabo.- Non necessitatibus molestias in aspernatur. Soluta pariatur odio- beatae reprehenderit nemo. At harum nihil libero maxime laboriosam- labore dolorem ratione. Praesentium veniam asperiores harum enim.- Commodi pariatur beatae dolore ex fugit iusto quis. Ut nam quasi- asperiores exercitationem. Perferendis quasi nobis dolore culpa.- Necessitatibus provident ipsam corporis dolores. Corporis praesentium- ex suscipit quidem. Minima distinctio voluptates optio veniam voluptatem.- Voluptates culpa dolor ratione veritatis maiores ipsum ducimus.- Earum ducimus veritatis eaque possimus commodi. Doloribus nulla- suscipit pariatur illo itaque saepe iure occaecati. Beatae dicta- numquam recusandae quasi atque iure dolor accusantium. Magnam ut- est quia expedita.+ description: Soluta praesentium earum assumenda commodi illo voluptatibus+ necessitatibus. Tempore nobis cum quaerat expedita. Ipsa labore+ nisi odio non eveniet quae aperiam nesciunt. Impedit non expedita+ inventore odio veritatis voluptas aliquid quia. Officia repudiandae+ suscipit impedit ipsam provident illo nobis. Ad magnam a at temporibus+ molestias exercitationem esse. Repellat facilis aliquid eligendi+ nulla molestiae officia error deleniti. Repellat dicta natus voluptates+ incidunt labore qui. Illo maiores illum nostrum voluptatibus perferendis.+ Maxime nihil iste inventore provident. Voluptas ab assumenda quisquam+ fugiat non magnam laudantium. Eum vitae sed incidunt ad repellat+ atque sint exercitationem. Quam saepe sint nulla atque.description_html: |-- Molestias eveniet quibusdam suscipit odit. Accusamus quo cumque officia necessitatibus libero repudiandae facilis explicabo. Non necessitatibus molestias in aspernatur. Soluta pariatur odio beatae reprehenderit nemo.- At harum nihil libero maxime laboriosam labore dolorem ratione. Praesentium veniam asperiores harum enim. Commodi pariatur beatae dolore ex fugit iusto quis.- Ut nam quasi asperiores exercitationem. Perferendis quasi nobis dolore culpa. Necessitatibus provident ipsam corporis dolores. Corporis praesentium ex suscipit quidem. Minima distinctio voluptates optio veniam voluptatem.- Voluptates culpa dolor ratione veritatis maiores ipsum ducimus. Earum ducimus veritatis eaque possimus commodi. Doloribus nulla suscipit pariatur illo itaque saepe iure occaecati. Beatae dicta numquam recusandae quasi atque iure dolor accusantium. Magnam ut est quia expedita.+ Soluta praesentium earum assumenda commodi illo voluptatibus necessitatibus. Tempore nobis cum quaerat expedita. Ipsa labore nisi odio non eveniet quae aperiam nesciunt. Impedit non expedita inventore odio veritatis voluptas aliquid quia. Officia repudiandae suscipit impedit ipsam provident illo nobis.+ Ad magnam a at temporibus molestias exercitationem esse. Repellat facilis aliquid eligendi nulla molestiae officia error deleniti. Repellat dicta natus voluptates incidunt labore qui. Illo maiores illum nostrum voluptatibus perferendis. Maxime nihil iste inventore provident.+ Voluptas ab assumenda quisquam fugiat non magnam laudantium. Eum vitae sed incidunt ad repellat atque sint exercitationem. Quam saepe sint nulla atque.default_variant_id: variant_UkLWZg9DAJthumbnail_url:tags: []@@ -12082,14 +12067,14 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-06-01T13:01:49.217Z'- updated_at: '2026-06-01T13:01:49.217Z'+ created_at: '2026-06-05T13:12:54.904Z'+ updated_at: '2026-06-05T13:12:54.904Z'original_price:status: activemetadata: {}deleted_at:- created_at: '2026-06-01T13:01:49.204Z'- updated_at: '2026-06-01T13:01:49.519Z'+ created_at: '2026-06-05T13:12:54.891Z'+ updated_at: '2026-06-05T13:12:55.197Z'tax_category_id: taxcat_UkLWZg9DAJschema:"$ref": "#/components/schemas/Product"@@ -12738,8 +12723,8 @@ paths:example:data:- id: pact_UkLWZg9DAJ- created_at: '2026-06-01T13:01:53.471Z'- updated_at: '2026-06-01T13:01:53.471Z'+ created_at: '2026-06-05T13:12:59.224Z'+ updated_at: '2026-06-05T13:12:59.224Z'type: free_shippingpromotion_id: promo_UkLWZg9DAJpreferences: {}@@ -12800,8 +12785,8 @@ paths:application/json:example:id: pact_UkLWZg9DAJ- created_at: '2026-06-01T13:01:54.043Z'- updated_at: '2026-06-01T13:01:54.043Z'+ created_at: '2026-06-05T13:12:59.785Z'+ updated_at: '2026-06-05T13:12:59.785Z'type: free_shippingpromotion_id: promo_UkLWZg9DAJpreferences: {}@@ -12911,8 +12896,8 @@ paths:example:data:- id: prorule_UkLWZg9DAJ- created_at: '2026-06-01T13:01:54.627Z'- updated_at: '2026-06-01T13:01:54.627Z'+ created_at: '2026-06-05T13:13:00.378Z'+ updated_at: '2026-06-05T13:13:00.378Z'type: currencypromotion_id: promo_UkLWZg9DAJpreferences:@@ -12979,8 +12964,8 @@ paths:application/json:example:id: prorule_UkLWZg9DAJ- created_at: '2026-06-01T13:01:55.194Z'- updated_at: '2026-06-01T13:01:55.194Z'+ created_at: '2026-06-05T13:13:00.940Z'+ updated_at: '2026-06-05T13:13:00.940Z'type: currencypromotion_id: promo_UkLWZg9DAJpreferences:@@ -13053,8 +13038,8 @@ paths:application/json:example:id: prorule_UkLWZg9DAJ- created_at: '2026-06-01T13:01:55.489Z'- updated_at: '2026-06-01T13:01:55.762Z'+ created_at: '2026-06-05T13:13:01.231Z'+ updated_at: '2026-06-05T13:13:01.523Z'type: currencypromotion_id: promo_UkLWZg9DAJpreferences:@@ -13144,7 +13129,7 @@ paths:name: Summer Saledescription:code: summer- starts_at: '2026-06-01T13:01:56.053Z'+ starts_at: '2026-06-05T13:13:01.832Z'expires_at:usage_limit:match_policy: all@@ -13155,10 +13140,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-06-01T13:01:56.054Z'- updated_at: '2026-06-01T13:01:56.055Z'- store_ids:- - store_UkLWZg9DAJ+ created_at: '2026-06-05T13:13:01.833Z'+ updated_at: '2026-06-05T13:13:01.835Z'action_ids: []rule_ids: []meta:@@ -13262,7 +13245,7 @@ paths:name: Black Fridaydescription:code: blackfriday-os- starts_at: '2026-06-01T13:01:56.945Z'+ starts_at: '2026-06-05T13:13:02.777Z'expires_at:usage_limit:match_policy: all@@ -13273,10 +13256,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-06-01T13:01:56.946Z'- updated_at: '2026-06-01T13:01:56.964Z'- store_ids:- - store_UkLWZg9DAJ+ created_at: '2026-06-05T13:13:02.779Z'+ updated_at: '2026-06-05T13:13:02.797Z'action_ids:- pact_UkLWZg9DAJ- pact_gbHJdmfrXB@@ -13427,7 +13408,7 @@ paths:name: Summer Saledescription:code: summer- starts_at: '2026-06-01T13:01:57.271Z'+ starts_at: '2026-06-05T13:13:03.094Z'expires_at:usage_limit:match_policy: all@@ -13438,10 +13419,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-06-01T13:01:57.272Z'- updated_at: '2026-06-01T13:01:57.272Z'- store_ids:- - store_UkLWZg9DAJ+ created_at: '2026-06-05T13:13:03.096Z'+ updated_at: '2026-06-05T13:13:03.097Z'action_ids: []rule_ids: []patch:@@ -13535,7 +13514,7 @@ paths:name: Summer Saledescription:code: summer- starts_at: '2026-06-01T13:01:58.161Z'+ starts_at: '2026-06-05T13:13:03.976Z'expires_at:usage_limit:match_policy: all@@ -13546,10 +13525,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-06-01T13:01:58.162Z'- updated_at: '2026-06-01T13:01:58.439Z'- store_ids:- - store_UkLWZg9DAJ+ created_at: '2026-06-05T13:13:03.977Z'+ updated_at: '2026-06-05T13:13:04.254Z'action_ids: []rule_ids: []requestBody:@@ -13842,12 +13819,12 @@ paths:label: Option Value(s)description:preference_schema:- - key: eligible_values- type: array- default: []- key: match_policytype: stringdefault: any+ - key: eligible_values+ type: array+ default: []- type: productlabel: Product(s)description:@@ -13899,8 +13876,8 @@ paths:data:- id: role_UkLWZg9DAJname: admin- created_at: '2026-06-01T13:01:59.328Z'- updated_at: '2026-06-01T13:01:59.328Z'+ created_at: '2026-06-05T13:13:05.141Z'+ updated_at: '2026-06-05T13:13:05.141Z'meta:page: 1limit: 25@@ -14035,8 +14012,8 @@ paths:pickup_stock_policy: localpickup_ready_in_minutes:pickup_instructions:- created_at: '2026-06-01T13:01:59.629Z'- updated_at: '2026-06-01T13:01:59.629Z'+ created_at: '2026-06-05T13:13:05.424Z'+ updated_at: '2026-06-05T13:13:05.424Z'meta:page: 1limit: 25@@ -14147,8 +14124,8 @@ paths:pickup_stock_policy: localpickup_ready_in_minutes: 30pickup_instructions:- created_at: '2026-06-01T13:02:00.248Z'- updated_at: '2026-06-01T13:02:00.248Z'+ created_at: '2026-06-05T13:13:05.993Z'+ updated_at: '2026-06-05T13:13:05.993Z'schema:"$ref": "#/components/schemas/StockLocation"'422':@@ -14322,8 +14299,8 @@ paths:pickup_stock_policy: localpickup_ready_in_minutes:pickup_instructions:- created_at: '2026-06-01T13:02:00.541Z'- updated_at: '2026-06-01T13:02:00.541Z'+ created_at: '2026-06-05T13:13:06.281Z'+ updated_at: '2026-06-05T13:13:06.281Z'schema:"$ref": "#/components/schemas/StockLocation"'404':@@ -14408,8 +14385,8 @@ paths:pickup_stock_policy: localpickup_ready_in_minutes: 45pickup_instructions:- created_at: '2026-06-01T13:02:01.102Z'- updated_at: '2026-06-01T13:02:01.374Z'+ created_at: '2026-06-05T13:13:06.840Z'+ updated_at: '2026-06-05T13:13:07.113Z'schema:"$ref": "#/components/schemas/StockLocation"'422':@@ -14612,8 +14589,8 @@ paths:data:- id: sccat_UkLWZg9DAJname: Goodwill- created_at: '2026-06-01T13:02:01.942Z'- updated_at: '2026-06-01T13:02:01.942Z'+ created_at: '2026-06-05T13:13:07.692Z'+ updated_at: '2026-06-05T13:13:07.692Z'non_expiring: falsemeta:page: 1@@ -14704,8 +14681,8 @@ paths:example:id: sccat_UkLWZg9DAJname: Goodwill- created_at: '2026-06-01T13:02:02.232Z'- updated_at: '2026-06-01T13:02:02.232Z'+ created_at: '2026-06-05T13:13:08.000Z'+ updated_at: '2026-06-05T13:13:08.000Z'non_expiring: falseschema:"$ref": "#/components/schemas/StoreCreditCategory"@@ -14766,18 +14743,23 @@ paths:name: Spree Test Storedefault_currency: USDdefault_locale: en+ mail_from_address: [email protected]+ customer_support_email: [email protected]+ new_order_notifications_email: [email protected]+ preferred_send_consumer_transactional_emails: truepreferred_admin_locale:preferred_timezone: UTCpreferred_weight_unit: lbpreferred_unit_system: imperial- created_at: '2026-06-01T13:00:31.956Z'- updated_at: '2026-06-01T13:02:02.798Z'+ created_at: '2026-06-05T13:11:36.359Z'+ updated_at: '2026-06-05T13:13:08.602Z'url: http://www.example.com:3000supported_currencies:- USDsupported_locales:- enlogo_url:+ mailer_logo_url:schema:"$ref": "#/components/schemas/Store"'401':@@ -14838,18 +14820,23 @@ paths:name: Renamed Storedefault_currency: USDdefault_locale: en+ mail_from_address: [email protected]+ customer_support_email: [email protected]+ new_order_notifications_email: [email protected]+ preferred_send_consumer_transactional_emails: truepreferred_admin_locale:preferred_timezone: UTCpreferred_weight_unit: lbpreferred_unit_system: imperial- created_at: '2026-06-01T13:00:31.956Z'- updated_at: '2026-06-01T13:02:03.412Z'+ created_at: '2026-06-05T13:11:36.359Z'+ updated_at: '2026-06-05T13:13:09.214Z'url: http://www.example.com:3000supported_currencies:- USDsupported_locales:- enlogo_url:+ mailer_logo_url:schema:"$ref": "#/components/schemas/Store"'422':@@ -15063,13 +15050,13 @@ paths:weight_unit: lbdimensions_unit:deleted_at:- created_at: '2026-06-01T13:02:04.804Z'- updated_at: '2026-06-01T13:02:04.815Z'+ created_at: '2026-06-05T13:13:10.660Z'+ updated_at: '2026-06-05T13:13:10.670Z'tax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 797554+ product_name: Product 791516- id: variant_gbHJdmfrXBproduct_id: prod_UkLWZg9DAJsku: SKU-98@@ -15080,10 +15067,10 @@ paths:purchasable: truein_stock: falsebackorderable: true- weight: 69.19- height: 3.71- width: 73.5- depth: 196.1+ weight: 126.85+ height: 146.34+ width: 142.5+ depth: 131.31price:id: price_gbHJdmfrXBamount: '19.99'@@ -15106,8 +15093,8 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:02:04.823Z'- updated_at: '2026-06-01T13:02:04.823Z'+ created_at: '2026-06-05T13:13:10.695Z'+ updated_at: '2026-06-05T13:13:10.695Z'metadata: {}position: 2cost_price: '17.0'@@ -15116,13 +15103,13 @@ paths:weight_unit: lbdimensions_unit:deleted_at:- created_at: '2026-06-01T13:02:04.822Z'- updated_at: '2026-06-01T13:02:04.834Z'+ created_at: '2026-06-05T13:13:10.692Z'+ updated_at: '2026-06-05T13:13:10.708Z'tax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 797554+ product_name: Product 791516meta:page: 1limit: 25@@ -15233,8 +15220,8 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:02:05.475Z'- updated_at: '2026-06-01T13:02:05.475Z'+ created_at: '2026-06-05T13:13:11.398Z'+ updated_at: '2026-06-05T13:13:11.398Z'metadata: {}position: 3cost_price:@@ -15243,13 +15230,13 @@ paths:weight_unit: lbdimensions_unit:deleted_at:- created_at: '2026-06-01T13:02:05.478Z'- updated_at: '2026-06-01T13:02:05.480Z'+ created_at: '2026-06-05T13:13:11.402Z'+ updated_at: '2026-06-05T13:13:11.404Z'tax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 808286+ product_name: Product 806635'422':description: validation errorcontent:@@ -15436,10 +15423,10 @@ paths:purchasable: truein_stock: falsebackorderable: true- weight: 121.66- height: 24.47- width: 117.76- depth: 54.94+ weight: 93.41+ height: 11.74+ width: 180.52+ depth: 114.88price:id: price_gbHJdmfrXBamount: '19.99'@@ -15462,8 +15449,8 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:02:05.892Z'- updated_at: '2026-06-01T13:02:05.892Z'+ created_at: '2026-06-05T13:13:11.790Z'+ updated_at: '2026-06-05T13:13:11.790Z'metadata: {}position: 2cost_price: '17.0'@@ -15472,13 +15459,13 @@ paths:weight_unit: lbdimensions_unit:deleted_at:- created_at: '2026-06-01T13:02:05.890Z'- updated_at: '2026-06-01T13:02:05.902Z'+ created_at: '2026-06-05T13:13:11.788Z'+ updated_at: '2026-06-05T13:13:11.797Z'tax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 827012+ product_name: Product 826512'404':description: variant not foundcontent:@@ -15557,10 +15544,10 @@ paths:purchasable: truein_stock: falsebackorderable: true- weight: 114.0- height: 190.98- width: 22.66- depth: 134.9+ weight: 198.83+ height: 53.66+ width: 153.45+ depth: 63.96price:id: price_gbHJdmfrXBamount: '19.99'@@ -15583,8 +15570,8 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-06-01T13:02:06.554Z'- updated_at: '2026-06-01T13:02:06.554Z'+ created_at: '2026-06-05T13:13:12.465Z'+ updated_at: '2026-06-05T13:13:12.465Z'metadata: {}position: 2cost_price: '17.0'@@ -15593,13 +15580,13 @@ paths:weight_unit: lbdimensions_unit:deleted_at:- created_at: '2026-06-01T13:02:06.552Z'- updated_at: '2026-06-01T13:02:06.841Z'+ created_at: '2026-06-05T13:13:12.462Z'+ updated_at: '2026-06-05T13:13:12.750Z'tax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 844088+ product_name: Product 842857requestBody:content:application/json:@@ -15733,198 +15720,1215 @@ paths:responses:'204':description: variant deleted-servers:-- url: http://{defaultHost}- variables:- defaultHost:- default: localhost:3000-tags:-- name: Authentication- description: Admin user authentication-- name: Product Catalog- description: Products, variants, and option types-- name: Orders- description: Order management — orders, items, payments, fulfillments, refunds,- gift cards, store credits-- name: Customers- description: Customer management — profiles, addresses, store credits, credit cards-- name: Configuration- description: Store configuration — payment methods, tag autocomplete-x-tagGroups:-- name: Authentication- tags:- - Authentication-- name: Product Catalog- tags:- - Product Catalog-- name: Orders- tags:- - Orders-- name: Customers- tags:- - Customers-- name: Configuration- tags:- - Configuration-components:- securitySchemes:- api_key:- type: apiKey- name: x-spree-api-key- in: header- description: Secret API key for admin access- bearer_auth:- type: http- scheme: bearer- bearerFormat: JWT- description: JWT token for admin user authentication- schemas:- PaginationMeta:- type: object- properties:- page:- type: integer- example: 1- limit:- type: integer- example: 25- count:- type: integer- example: 100- description: Total number of records- pages:- type: integer- example: 4- description: Total number of pages- from:- type: integer- example: 1- description: Index of first record on this page- to:- type: integer- example: 25- description: Index of last record on this page- in:- type: integer- example: 25- description: Number of records on this page- previous:+ "/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries":+ parameters:+ - name: webhook_endpoint_id+ in: path+ required: true+ description: Parent webhook endpoint ID+ schema:+ type: string+ get:+ summary: List webhook deliveries+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Returns delivery attempts for the given endpoint, most recent first.+ Each row carries the original request payload, the response code+ (when the receiver replied), the execution time, and any transport+ error — everything needed to audit failures and decide whether to+ redeliver.+++ **Required scope:** `read_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const deliveries = await client.webhookEndpoints.deliveries.list('whe_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ - name: page+ in: query+ required: false+ description: Page number+ schema:type: integer- nullable: true- example:- description: Previous page number- next:+ - name: limit+ in: query+ required: false+ description: Number of records per page+ schema:type: integer- nullable: true- example: 2- description: Next page number- required:- - page- - limit- - count- - pages- - from- - to- - in- ErrorResponse:- type: object- properties:- error:- type: object- properties:- code:- type: string- example: record_not_found- message:- type: string- example: Record not found- details:- type: object- description: Field-specific validation errors- nullable: true- example:- name:- - is too short- - is required- email:- - is invalid- required:- - code- - message- required:- - error- example:- error:- code: validation_error- message: Validation failed- details:- name:- - is too short- email:- - is invalid- AuthResponse:- type: object- properties:- token:+ - name: q[event_name_eq]+ in: query+ required: false+ description: Filter by event name (exact)+ schema:type: string- description: JWT access token- user:- "$ref": "#/components/schemas/AdminUser"- required:- - token- - user- PermissionRule:- type: object- description: A single permission rule (CanCanCan rule). Rules are applied in- order, last-matching-wins.- properties:- allow:- type: boolean- description: true for `can`, false for `cannot`- actions:- type: array- items:- type: string- description: Action names, e.g. ["read", "update"] or ["manage"]- subjects:- type: array- items:- type: string- description: Subject class names, e.g. ["Spree::Product"] or ["all"]- has_conditions:+ - name: q[success_eq]+ in: query+ required: false+ description: Filter by success flag+ schema:type: boolean- description: True if the server-side rule has per-record conditions. The- SPA shows the action optimistically and handles 403 from the API.- required:- - allow- - actions- - subjects- - has_conditions- MeResponse:- type: object- description: Current admin user profile and serialized permissions- properties:- user:- "$ref": "#/components/schemas/AdminUser"- permissions:- type: array- items:- "$ref": "#/components/schemas/PermissionRule"- required:- - user- - permissions- CheckoutRequirement:- type: object- properties:- step:- type: string- description: Checkout step this requirement belongs to- example: payment- field:+ - name: sort+ in: query+ required: false+ description: Sort by field. Prefix with `-` for descending (e.g., `-delivered_at`).+ schema:type: string- description: Field that needs to be satisfied- example: payment- message:+ - name: fields+ in: query+ required: false+ description: Comma-separated list of fields to include. id is always included.+ schema:+ type: string+ responses:+ '200':+ description: deliveries found+ content:+ application/json:+ example:+ data:+ - id: whd_gbHJdmfrXB+ event_name: order.created+ event_id:+ response_code: 500+ execution_time: 200+ error_type:+ request_errors:+ response_body:+ success: false+ payload:+ event: order.created+ data:+ id: 1+ created_at: '2026-06-05T13:13:13.136Z'+ updated_at: '2026-06-05T13:13:13.136Z'+ delivered_at: '2026-06-05T13:13:13.136Z'+ webhook_endpoint_id: whe_UkLWZg9DAJ+ webhook_endpoint_url: https://shop.example.com/webhooks+ - id: whd_UkLWZg9DAJ+ event_name: order.created+ event_id:+ response_code: 200+ execution_time: 150+ error_type:+ request_errors:+ response_body:+ success: true+ payload:+ event: order.created+ data:+ id: 1+ created_at: '2026-06-05T13:13:13.135Z'+ updated_at: '2026-06-05T13:13:13.135Z'+ delivered_at: '2026-06-05T13:13:13.135Z'+ webhook_endpoint_id: whe_UkLWZg9DAJ+ webhook_endpoint_url: https://shop.example.com/webhooks+ meta:+ page: 1+ limit: 25+ count: 2+ pages: 1+ from: 1+ to: 2+ in: 2+ previous:+ next:+ '404':+ description: parent webhook endpoint not found+ content:+ application/json:+ example:+ error:+ code: record_not_found+ message: Webhook endpoint not found+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ "/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}":+ parameters:+ - name: webhook_endpoint_id+ in: path+ required: true+ description: Parent webhook endpoint ID+ schema:+ type: string+ - name: id+ in: path+ required: true+ description: Webhook delivery ID+ schema:+ type: string+ get:+ summary: Get a webhook delivery+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Returns a single delivery attempt with the full request payload and+ the response body the receiver returned. Use this for ad-hoc debug+ of failed deliveries.+++ **Required scope:** `read_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const delivery = await client.webhookEndpoints.deliveries.get('whe_xxx', 'whd_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ - name: fields+ in: query+ required: false+ description: Comma-separated list of fields to include. id is always included.+ schema:+ type: string+ responses:+ '200':+ description: delivery found+ content:+ application/json:+ example:+ id: whd_gbHJdmfrXB+ event_name: order.created+ event_id:+ response_code: 500+ execution_time: 200+ error_type:+ request_errors:+ response_body:+ success: false+ payload:+ event: order.created+ data:+ id: 1+ created_at: '2026-06-05T13:13:13.753Z'+ updated_at: '2026-06-05T13:13:13.753Z'+ delivered_at: '2026-06-05T13:13:13.753Z'+ webhook_endpoint_id: whe_UkLWZg9DAJ+ webhook_endpoint_url: https://shop.example.com/webhooks+ '404':+ description: delivery not found+ content:+ application/json:+ example:+ error:+ code: record_not_found+ message: Webhook delivery not found+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ "/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}/redeliver":+ parameters:+ - name: webhook_endpoint_id+ in: path+ required: true+ description: Parent webhook endpoint ID+ schema:+ type: string+ - name: id+ in: path+ required: true+ description: Webhook delivery ID to redeliver+ schema:+ type: string+ post:+ summary: Redeliver a webhook delivery+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Creates a new delivery row with the same payload + event_name and+ queues it. The original row is preserved for audit history.+++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Creates a new delivery row with the same payload + event_name and queues+ // it. The original row is preserved for audit history.+ const delivery = await client.webhookEndpoints.deliveries.redeliver('whe_xxx', 'whd_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '201':+ description: redelivery queued+ content:+ application/json:+ example:+ id: whd_EfhxLZ9ck8+ event_name: order.created+ event_id:+ response_code:+ execution_time:+ error_type:+ request_errors:+ response_body:+ success:+ payload:+ event: order.created+ data:+ id: 1+ created_at: '2026-06-05T13:13:14.655Z'+ updated_at: '2026-06-05T13:13:14.655Z'+ delivered_at:+ webhook_endpoint_id: whe_UkLWZg9DAJ+ webhook_endpoint_url: https://shop.example.com/webhooks+ "/api/v3/admin/webhook_endpoints":+ get:+ summary: List webhook endpoints+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Returns outbound webhook subscriptions for the current store. Each+ endpoint receives a signed POST when any subscribed event fires.+ `secret_key` is `null` on list reads — the plaintext is delivered+ exactly once on create.+++ **Required scope:** `read_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const endpoints = await client.webhookEndpoints.list()+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ - name: page+ in: query+ required: false+ description: Page number+ schema:+ type: integer+ - name: limit+ in: query+ required: false+ description: Number of records per page+ schema:+ type: integer+ - name: q[name_cont]+ in: query+ required: false+ description: Filter by name (contains)+ schema:+ type: string+ - name: q[url_cont]+ in: query+ required: false+ description: Filter by URL (contains)+ schema:+ type: string+ - name: sort+ in: query+ required: false+ description: Sort by field. Prefix with `-` for descending (e.g., `-created_at`).+ schema:+ type: string+ - name: fields+ in: query+ required: false+ description: Comma-separated list of fields to include. id is always included.+ schema:+ type: string+ responses:+ '200':+ description: webhook endpoints found+ content:+ application/json:+ example:+ data:+ - id: whe_UkLWZg9DAJ+ name: Order pipeline+ url: https://shop.example.com/webhooks/orders+ active: true+ subscriptions:+ - order.created+ - order.completed+ - product.created+ disabled_reason:+ created_at: '2026-06-05T13:13:14.683Z'+ updated_at: '2026-06-05T13:13:14.683Z'+ disabled_at:+ secret_key:+ last_delivery_at:+ recent_delivery_count: 0+ recent_failure_count: 0+ total_delivery_count: 0+ successful_delivery_count: 0+ failed_delivery_count: 0+ meta:+ page: 1+ limit: 25+ count: 1+ pages: 1+ from: 1+ to: 1+ in: 1+ previous:+ next:+ '401':+ description: unauthorized+ content:+ application/json:+ example:+ error:+ code: authentication_required+ message: Authentication required+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ post:+ summary: Create a webhook endpoint+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Creates a new outbound webhook subscription. The plaintext+ `secret_key` is returned **once** in this response — persist it+ immediately to verify incoming webhook signatures. Subsequent reads+ return `null` for the secret. Pass an empty `subscriptions` array or+ omit it to receive every event.+++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const endpoint = await client.webhookEndpoints.create({+ name: 'Order pipeline',+ url: 'https://example.com/webhooks/orders',+ active: true,+ subscriptions: ['order.completed', 'order.canceled'],+ })++ // The plaintext `secret_key` is returned exactly once on create — persist it+ // immediately so you can verify incoming webhook signatures. Subsequent reads+ // will return `null`.+ const signingSecret = endpoint.secret_key+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '201':+ description: webhook endpoint created — secret_key returned once+ content:+ application/json:+ example:+ id: whe_gbHJdmfrXB+ name: CI integration+ url: https://ci.example.com/webhooks+ active: true+ subscriptions:+ - order.completed+ disabled_reason:+ created_at: '2026-06-05T13:13:15.322Z'+ updated_at: '2026-06-05T13:13:15.322Z'+ disabled_at:+ secret_key: 81a1cd93ff52f5e579fa149c0621ca1f15817eead13ebdd8f807f5a71ec43353+ last_delivery_at:+ recent_delivery_count: 0+ recent_failure_count: 0+ total_delivery_count: 0+ successful_delivery_count: 0+ failed_delivery_count: 0+ '422':+ description: validation error+ content:+ application/json:+ example:+ error:+ code: validation_error+ message: |-+ Url Translation missing. Options considered were:+ - en.activerecord.errors.models.spree/webhook_endpoint.attributes.url.invalid_url+ - en.activerecord.errors.models.spree/webhook_endpoint.invalid_url+ - en.activerecord.errors.messages.invalid_url+ - en.errors.attributes.url.invalid_url+ - en.errors.messages.invalid_url+ details:+ url:+ - |-+ Translation missing. Options considered were:+ - en.activerecord.errors.models.spree/webhook_endpoint.attributes.url.invalid_url+ - en.activerecord.errors.models.spree/webhook_endpoint.invalid_url+ - en.activerecord.errors.messages.invalid_url+ - en.errors.attributes.url.invalid_url+ - en.errors.messages.invalid_url+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ requestBody:+ content:+ application/json:+ schema:+ type: object+ required:+ - url+ properties:+ name:+ type: string+ example: Order pipeline+ url:+ type: string+ example: https://example.com/webhooks/orders+ active:+ type: boolean+ example: true+ subscriptions:+ type: array+ items:+ type: string+ example:+ - order.completed+ - order.canceled+ "/api/v3/admin/webhook_endpoints/{id}":+ parameters:+ - name: id+ in: path+ required: true+ description: Webhook endpoint ID+ schema:+ type: string+ get:+ summary: Get a webhook endpoint+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Returns a single webhook endpoint by prefixed ID.++ **Required scope:** `read_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const endpoint = await client.webhookEndpoints.get('whe_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ - name: fields+ in: query+ required: false+ description: Comma-separated list of fields to include. id is always included.+ schema:+ type: string+ responses:+ '200':+ description: webhook endpoint found+ content:+ application/json:+ example:+ id: whe_UkLWZg9DAJ+ name: Order pipeline+ url: https://shop.example.com/webhooks/orders+ active: true+ subscriptions:+ - order.created+ - order.completed+ - product.created+ disabled_reason:+ created_at: '2026-06-05T13:13:15.645Z'+ updated_at: '2026-06-05T13:13:15.645Z'+ disabled_at:+ secret_key:+ last_delivery_at:+ recent_delivery_count: 0+ recent_failure_count: 0+ total_delivery_count: 0+ successful_delivery_count: 0+ failed_delivery_count: 0+ '404':+ description: webhook endpoint not found+ content:+ application/json:+ example:+ error:+ code: record_not_found+ message: Webhook endpoint not found+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ patch:+ summary: Update a webhook endpoint+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Updates name, URL, active flag, or the event subscription list.+ Toggling `active` here is equivalent to calling `disable`/`enable`+ without an audit reason.+++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const endpoint = await client.webhookEndpoints.update('whe_xxx', {+ name: 'Order pipeline (v2)',+ subscriptions: ['order.completed', 'order.canceled', 'order.paid'],+ })+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '200':+ description: webhook endpoint updated+ content:+ application/json:+ example:+ id: whe_UkLWZg9DAJ+ name: Order pipeline (renamed)+ url: https://shop.example.com/webhooks/orders+ active: true+ subscriptions:+ - order.created+ - order.completed+ - product.created+ disabled_reason:+ created_at: '2026-06-05T13:13:16.252Z'+ updated_at: '2026-06-05T13:13:16.530Z'+ disabled_at:+ secret_key:+ last_delivery_at:+ recent_delivery_count: 0+ recent_failure_count: 0+ total_delivery_count: 0+ successful_delivery_count: 0+ failed_delivery_count: 0+ '422':+ description: validation error+ content:+ application/json:+ example:+ error:+ code: validation_error+ message: |-+ Url Translation missing. Options considered were:+ - en.activerecord.errors.models.spree/webhook_endpoint.attributes.url.invalid_url+ - en.activerecord.errors.models.spree/webhook_endpoint.invalid_url+ - en.activerecord.errors.messages.invalid_url+ - en.errors.attributes.url.invalid_url+ - en.errors.messages.invalid_url+ details:+ url:+ - |-+ Translation missing. Options considered were:+ - en.activerecord.errors.models.spree/webhook_endpoint.attributes.url.invalid_url+ - en.activerecord.errors.models.spree/webhook_endpoint.invalid_url+ - en.activerecord.errors.messages.invalid_url+ - en.errors.attributes.url.invalid_url+ - en.errors.messages.invalid_url+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ requestBody:+ content:+ application/json:+ schema:+ type: object+ properties:+ name:+ type: string+ url:+ type: string+ active:+ type: boolean+ subscriptions:+ type: array+ items:+ type: string+ delete:+ summary: Delete a webhook endpoint+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Soft-deletes the endpoint and stops future deliveries.++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ await client.webhookEndpoints.delete('whe_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '204':+ description: webhook endpoint deleted+ "/api/v3/admin/webhook_endpoints/{id}/send_test":+ parameters:+ - name: id+ in: path+ required: true+ description: Webhook endpoint ID+ schema:+ type: string+ post:+ summary: Send a test delivery+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Creates a `webhook.test` delivery record and queues it. Use this to+ verify the endpoint is reachable and your signature verification+ accepts Spree's payloads.+++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Fires a synthetic `webhook.test` delivery so you can verify the endpoint is+ // reachable and your signature-verification code accepts Spree's payloads.+ const delivery = await client.webhookEndpoints.sendTest('whe_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '201':+ description: test delivery queued+ content:+ application/json:+ example:+ id: whd_UkLWZg9DAJ+ event_name: webhook.test+ event_id:+ response_code:+ execution_time:+ error_type:+ request_errors:+ response_body:+ success:+ payload:+ id: 9ac8d08d-e321-4228-98c1-5e4bd30d7e16+ name: webhook.test+ created_at: '2026-06-05T13:13:17Z'+ data:+ message: This is a test webhook from Spree.+ metadata:+ spree_version: 5.5.0.beta+ created_at: '2026-06-05T13:13:17.450Z'+ updated_at: '2026-06-05T13:13:17.450Z'+ delivered_at:+ webhook_endpoint_id: whe_UkLWZg9DAJ+ webhook_endpoint_url: https://shop.example.com/webhooks/orders+ "/api/v3/admin/webhook_endpoints/{id}/enable":+ parameters:+ - name: id+ in: path+ required: true+ description: Webhook endpoint ID+ schema:+ type: string+ patch:+ summary: Re-enable a webhook endpoint+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Re-enables an endpoint that was manually or automatically disabled.++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Re-enable an endpoint that was auto-disabled after repeated delivery failures.+ const endpoint = await client.webhookEndpoints.enable('whe_xxx')+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '200':+ description: webhook endpoint enabled+ content:+ application/json:+ example:+ id: whe_UkLWZg9DAJ+ name: Order pipeline+ url: https://shop.example.com/webhooks/orders+ active: true+ subscriptions:+ - order.created+ - order.completed+ - product.created+ disabled_reason:+ created_at: '2026-06-05T13:13:17.480Z'+ updated_at: '2026-06-05T13:13:17.770Z'+ disabled_at:+ secret_key:+ last_delivery_at:+ recent_delivery_count: 0+ recent_failure_count: 0+ total_delivery_count: 0+ successful_delivery_count: 0+ failed_delivery_count: 0+ "/api/v3/admin/webhook_endpoints/{id}/disable":+ parameters:+ - name: id+ in: path+ required: true+ description: Webhook endpoint ID+ schema:+ type: string+ patch:+ summary: Disable a webhook endpoint+ tags:+ - Configuration+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Manually pauses an endpoint. Unlike auto-disable (triggered after+ repeated delivery failures), no notification email is sent.+++ **Required scope:** `write_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Pause an endpoint without deleting it. The optional `reason` is shown next+ // to the disabled indicator in the admin.+ const endpoint = await client.webhookEndpoints.disable('whe_xxx', {+ reason: 'Investigating elevated 5xx rate',+ })+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ responses:+ '200':+ description: webhook endpoint disabled+ content:+ application/json:+ example:+ id: whe_UkLWZg9DAJ+ name: Order pipeline+ url: https://shop.example.com/webhooks/orders+ active: false+ subscriptions:+ - order.created+ - order.completed+ - product.created+ disabled_reason: Investigating+ created_at: '2026-06-05T13:13:17.803Z'+ updated_at: '2026-06-05T13:13:18.094Z'+ disabled_at: '2026-06-05T13:13:18.094Z'+ secret_key:+ last_delivery_at:+ recent_delivery_count: 0+ recent_failure_count: 0+ total_delivery_count: 0+ successful_delivery_count: 0+ failed_delivery_count: 0+ requestBody:+ content:+ application/json:+ schema:+ type: object+ properties:+ reason:+ type: string+ example: Investigating elevated 5xx rate+servers:+- url: http://{defaultHost}+ variables:+ defaultHost:+ default: localhost:3000+tags:+- name: Authentication+ description: Admin user authentication+- name: Product Catalog+ description: Products, variants, and option types+- name: Orders+ description: Order management — orders, items, payments, fulfillments, refunds,+ gift cards, store credits+- name: Customers+ description: Customer management — profiles, addresses, store credits, credit cards+- name: Configuration+ description: Store configuration — payment methods, tag autocomplete+x-tagGroups:+- name: Authentication+ tags:+ - Authentication+- name: Product Catalog+ tags:+ - Product Catalog+- name: Orders+ tags:+ - Orders+- name: Customers+ tags:+ - Customers+- name: Configuration+ tags:+ - Configuration+components:+ securitySchemes:+ api_key:+ type: apiKey+ name: x-spree-api-key+ in: header+ description: Secret API key for admin access+ bearer_auth:+ type: http+ scheme: bearer+ bearerFormat: JWT+ description: JWT token for admin user authentication+ schemas:+ PaginationMeta:+ type: object+ properties:+ page:+ type: integer+ example: 1+ limit:+ type: integer+ example: 25+ count:+ type: integer+ example: 100+ description: Total number of records+ pages:+ type: integer+ example: 4+ description: Total number of pages+ from:+ type: integer+ example: 1+ description: Index of first record on this page+ to:+ type: integer+ example: 25+ description: Index of last record on this page+ in:+ type: integer+ example: 25+ description: Number of records on this page+ previous:+ type: integer+ nullable: true+ example:+ description: Previous page number+ next:+ type: integer+ nullable: true+ example: 2+ description: Next page number+ required:+ - page+ - limit+ - count+ - pages+ - from+ - to+ - in+ ErrorResponse:+ type: object+ properties:+ error:+ type: object+ properties:+ code:+ type: string+ example: record_not_found+ message:+ type: string+ example: Record not found+ details:+ type: object+ description: Field-specific validation errors+ nullable: true+ example:+ name:+ - is too short+ - is required+ email:+ - is invalid+ required:+ - code+ - message+ required:+ - error+ example:+ error:+ code: validation_error+ message: Validation failed+ details:+ name:+ - is too short+ email:+ - is invalid+ AuthResponse:+ type: object+ properties:+ token:+ type: string+ description: JWT access token+ user:+ "$ref": "#/components/schemas/AdminUser"+ required:+ - token+ - user+ PermissionRule:+ type: object+ description: A single permission rule (CanCanCan rule). Rules are applied in+ order, last-matching-wins.+ properties:+ allow:+ type: boolean+ description: true for `can`, false for `cannot`+ actions:+ type: array+ items:+ type: string+ description: Action names, e.g. ["read", "update"] or ["manage"]+ subjects:+ type: array+ items:+ type: string+ description: Subject class names, e.g. ["Spree::Product"] or ["all"]+ has_conditions:+ type: boolean+ description: True if the server-side rule has per-record conditions. The+ SPA shows the action optimistically and handles 403 from the API.+ required:+ - allow+ - actions+ - subjects+ - has_conditions+ MeResponse:+ type: object+ description: Current admin user profile and serialized permissions+ properties:+ user:+ "$ref": "#/components/schemas/AdminUser"+ permissions:+ type: array+ items:+ "$ref": "#/components/schemas/PermissionRule"+ required:+ - user+ - permissions+ CheckoutRequirement:+ type: object+ properties:+ step:+ type: string+ description: Checkout step this requirement belongs to+ example: payment+ field:+ type: string+ description: Field that needs to be satisfied+ example: payment+ message:type: stringdescription: Human-readable requirement messageexample: Add a payment method@@ -16213,14 +17217,11 @@ components:type: stringupdated_at:type: string- store_id:- type: stringrequired:- id- origin- created_at- updated_at- - store_idx-typelizer: trueApiKey:type: object@@ -16372,6 +17373,8 @@ components:type: stringactive:type: boolean+ default:+ type: booleanpreferred_order_routing_strategy:type: stringnullable: true@@ -16379,17 +17382,15 @@ components:type: stringupdated_at:type: string- store_id:- type: stringrequired:- id- name- code- active+ - default- preferred_order_routing_strategy- created_at- updated_at- - store_idx-typelizer: trueCountry:type: object@@ -18038,6 +19039,18 @@ components:description:type: stringnullable: true+ markets:+ type: array+ items:+ "$ref": "#/components/schemas/Market"+ customer_groups:+ type: array+ items:+ "$ref": "#/components/schemas/CustomerGroup"+ customers:+ type: array+ items:+ "$ref": "#/components/schemas/Customer"required:- id- created_at@@ -18116,28 +19129,18 @@ components:type: stringchannel_id:type: string- units_sold_count:- type: number- revenue:- type: string- nullable: truecreated_at:type: stringupdated_at:type: string- store_id:- type: stringrequired:- id- published_at- unpublished_at- product_id- channel_id- - units_sold_count- - revenue- created_at- updated_at- - store_idx-typelizer: trueProduct:type: object@@ -18437,10 +19440,6 @@ components:type: stringupdated_at:type: string- store_ids:- type: array- items:- type: stringaction_ids:type: arrayitems:@@ -18467,7 +19466,6 @@ components:- metadata- created_at- updated_at- - store_ids- action_ids- rule_idsx-typelizer: true@@ -18919,6 +19917,17 @@ components:type: stringdefault_locale:type: string+ mail_from_address:+ type: string+ nullable: true+ customer_support_email:+ type: string+ nullable: true+ new_order_notifications_email:+ type: string+ nullable: true+ preferred_send_consumer_transactional_emails:+ type: booleanpreferred_admin_locale:type: stringnullable: true@@ -18945,12 +19954,19 @@ components:logo_url:type: stringnullable: true+ mailer_logo_url:+ type: string+ nullable: truerequired:- id- metadata- name- default_currency- default_locale+ - mail_from_address+ - customer_support_email+ - new_order_notifications_email+ - preferred_send_consumer_transactional_emails- preferred_admin_locale- preferred_timezone- preferred_weight_unit@@ -18961,6 +19977,7 @@ components:- supported_currencies- supported_locales- logo_url+ - mailer_logo_urlx-typelizer: trueTaxCategory:type: object@@ -19132,3 +20149,121 @@ components:- total_on_hand- product_namex-typelizer: true+ WebhookDelivery:+ type: object+ properties:+ id:+ type: string+ event_name:+ type: string+ event_id:+ type: string+ nullable: true+ response_code:+ type: number+ nullable: true+ execution_time:+ type: number+ nullable: true+ error_type:+ type: string+ nullable: true+ request_errors:+ type: string+ nullable: true+ response_body:+ type: string+ nullable: true+ success:+ type: boolean+ nullable: true+ payload:+ type: object+ created_at:+ type: string+ updated_at:+ type: string+ delivered_at:+ type: string+ nullable: true+ webhook_endpoint_id:+ type: string+ webhook_endpoint_url:+ type: string+ required:+ - id+ - event_name+ - event_id+ - response_code+ - execution_time+ - error_type+ - request_errors+ - response_body+ - success+ - payload+ - created_at+ - updated_at+ - delivered_at+ - webhook_endpoint_id+ - webhook_endpoint_url+ x-typelizer: true+ WebhookEndpoint:+ type: object+ properties:+ id:+ type: string+ name:+ type: string+ nullable: true+ url:+ type: string+ active:+ type: boolean+ subscriptions:+ type: array+ items:+ type: string+ disabled_reason:+ type: string+ nullable: true+ created_at:+ type: string+ updated_at:+ type: string+ disabled_at:+ type: string+ nullable: true+ secret_key:+ type: string+ nullable: true+ last_delivery_at:+ type: string+ nullable: true+ recent_delivery_count:+ type: number+ recent_failure_count:+ type: number+ total_delivery_count:+ type: number+ successful_delivery_count:+ type: number+ failed_delivery_count:+ type: number+ required:+ - id+ - name+ - url+ - active+ - subscriptions+ - disabled_reason+ - created_at+ - updated_at+ - disabled_at+ - secret_key+ - last_delivery_at+ - recent_delivery_count+ - recent_failure_count+ - total_delivery_count+ - successful_delivery_count+ - failed_delivery_count+ x-typelizer: truediff --git a/packages/admin-sdk/examples/webhook-endpoints/create.ts b/packages/admin-sdk/examples/webhook-endpoints/create.tsnew file mode 100644index 0000000000..5664723ee9--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/create.ts@@ -0,0 +1,23 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const endpoint = await client.webhookEndpoints.create({+ name: 'Order pipeline',+ url: 'https://example.com/webhooks/orders',+ active: true,+ subscriptions: ['order.completed', 'order.canceled'],+})++// The plaintext `secret_key` is returned exactly once on create — persist it+// immediately so you can verify incoming webhook signatures. Subsequent reads+// will return `null`.+const signingSecret = endpoint.secret_key++// endregion:example++export { endpoint, signingSecret }diff --git a/packages/admin-sdk/examples/webhook-endpoints/delete.ts b/packages/admin-sdk/examples/webhook-endpoints/delete.tsnew file mode 100644index 0000000000..24ef131847--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/delete.ts@@ -0,0 +1,11 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+await client.webhookEndpoints.delete('whe_xxx')++// endregion:examplediff --git a/packages/admin-sdk/examples/webhook-endpoints/deliveries/get.ts b/packages/admin-sdk/examples/webhook-endpoints/deliveries/get.tsnew file mode 100644index 0000000000..df2b09bd90--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/deliveries/get.ts@@ -0,0 +1,13 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const delivery = await client.webhookEndpoints.deliveries.get('whe_xxx', 'whd_xxx')++// endregion:example++export { delivery }diff --git a/packages/admin-sdk/examples/webhook-endpoints/deliveries/list.ts b/packages/admin-sdk/examples/webhook-endpoints/deliveries/list.tsnew file mode 100644index 0000000000..4bec58a7a9--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/deliveries/list.ts@@ -0,0 +1,13 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const deliveries = await client.webhookEndpoints.deliveries.list('whe_xxx')++// endregion:example++export { deliveries }diff --git a/packages/admin-sdk/examples/webhook-endpoints/deliveries/redeliver.ts b/packages/admin-sdk/examples/webhook-endpoints/deliveries/redeliver.tsnew file mode 100644index 0000000000..7f1285013f--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/deliveries/redeliver.ts@@ -0,0 +1,15 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+// Creates a new delivery row with the same payload + event_name and queues+// it. The original row is preserved for audit history.+const delivery = await client.webhookEndpoints.deliveries.redeliver('whe_xxx', 'whd_xxx')++// endregion:example++export { delivery }diff --git a/packages/admin-sdk/examples/webhook-endpoints/disable.ts b/packages/admin-sdk/examples/webhook-endpoints/disable.tsnew file mode 100644index 0000000000..ff72ad1274--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/disable.ts@@ -0,0 +1,17 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+// Pause an endpoint without deleting it. The optional `reason` is shown next+// to the disabled indicator in the admin.+const endpoint = await client.webhookEndpoints.disable('whe_xxx', {+ reason: 'Investigating elevated 5xx rate',+})++// endregion:example++export { endpoint }diff --git a/packages/admin-sdk/examples/webhook-endpoints/enable.ts b/packages/admin-sdk/examples/webhook-endpoints/enable.tsnew file mode 100644index 0000000000..9268d0f47f--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/enable.ts@@ -0,0 +1,14 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+// Re-enable an endpoint that was auto-disabled after repeated delivery failures.+const endpoint = await client.webhookEndpoints.enable('whe_xxx')++// endregion:example++export { endpoint }diff --git a/packages/admin-sdk/examples/webhook-endpoints/get.ts b/packages/admin-sdk/examples/webhook-endpoints/get.tsnew file mode 100644index 0000000000..2150a3f77d--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/get.ts@@ -0,0 +1,13 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const endpoint = await client.webhookEndpoints.get('whe_xxx')++// endregion:example++export { endpoint }diff --git a/packages/admin-sdk/examples/webhook-endpoints/list.ts b/packages/admin-sdk/examples/webhook-endpoints/list.tsnew file mode 100644index 0000000000..a5ed28762a--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/list.ts@@ -0,0 +1,13 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const endpoints = await client.webhookEndpoints.list()++// endregion:example++export { endpoints }diff --git a/packages/admin-sdk/examples/webhook-endpoints/send-test.ts b/packages/admin-sdk/examples/webhook-endpoints/send-test.tsnew file mode 100644index 0000000000..fa4733869e--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/send-test.ts@@ -0,0 +1,15 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+// Fires a synthetic `webhook.test` delivery so you can verify the endpoint is+// reachable and your signature-verification code accepts Spree's payloads.+const delivery = await client.webhookEndpoints.sendTest('whe_xxx')++// endregion:example++export { delivery }diff --git a/packages/admin-sdk/examples/webhook-endpoints/update.ts b/packages/admin-sdk/examples/webhook-endpoints/update.tsnew file mode 100644index 0000000000..4e8ea79f08--- /dev/null+++ b/packages/admin-sdk/examples/webhook-endpoints/update.ts@@ -0,0 +1,16 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const endpoint = await client.webhookEndpoints.update('whe_xxx', {+ name: 'Order pipeline (v2)',+ subscriptions: ['order.completed', 'order.canceled', 'order.paid'],+})++// endregion:example++export { endpoint }diff --git a/packages/admin-sdk/src/admin-client.ts b/packages/admin-sdk/src/admin-client.tsindex cfaacacd8c..bb7ee59d19 100644--- a/packages/admin-sdk/src/admin-client.ts+++ b/packages/admin-sdk/src/admin-client.ts@@ -138,6 +138,9 @@ import type {TaxCategoryUpdateParams,VariantCreateParams,VariantUpdateParams,+ WebhookEndpointCreateParams,+ WebhookEndpointDisableParams,+ WebhookEndpointUpdateParams,} from './params'import type {Address,@@ -182,6 +185,8 @@ import type {StoreCreditCategory,TaxCategory,Variant,+ WebhookDelivery,+ WebhookEndpoint,} from './types'/**@@ -2153,6 +2158,111 @@ export class AdminClient {this.request<void>('DELETE', `/allowed_origins/${id}`, options),}+ // ============================================+ // Webhook Endpoints + Deliveries+ // ============================================++ /**+ * Outbound webhook subscriptions: each endpoint receives a signed POST when+ * any subscribed event fires (`subscriptions` is a list of event names or+ * `*` patterns). The plaintext `secret_key` is returned **once** on create —+ * persist it client-side immediately because later reads serialize `null`.+ * Each endpoint exposes a nested `deliveries` log for auditing and retry.+ */+ readonly webhookEndpoints = {+ list: (+ params?: ListParams & Record<string, unknown>,+ options?: RequestOptions,+ ): Promise<PaginatedResponse<WebhookEndpoint>> =>+ this.request<PaginatedResponse<WebhookEndpoint>>('GET', '/webhook_endpoints', {+ ...options,+ params: params ? transformListParams(params) : undefined,+ }),++ get: (+ id: string,+ params?: { expand?: string[] },+ options?: RequestOptions,+ ): Promise<WebhookEndpoint> =>+ this.request<WebhookEndpoint>('GET', `/webhook_endpoints/${id}`, {+ ...options,+ params: getParams(params),+ }),++ create: (+ params: WebhookEndpointCreateParams,+ options?: RequestOptions,+ ): Promise<WebhookEndpoint> =>+ this.request<WebhookEndpoint>('POST', '/webhook_endpoints', { ...options, body: params }),++ update: (+ id: string,+ params: WebhookEndpointUpdateParams,+ options?: RequestOptions,+ ): Promise<WebhookEndpoint> =>+ this.request<WebhookEndpoint>('PATCH', `/webhook_endpoints/${id}`, {+ ...options,+ body: params,+ }),++ delete: (id: string, options?: RequestOptions): Promise<void> =>+ this.request<void>('DELETE', `/webhook_endpoints/${id}`, options),++ /** Fires a synthetic `webhook.test` delivery so admins can verify reachability. */+ sendTest: (id: string, options?: RequestOptions): Promise<WebhookDelivery> =>+ this.request<WebhookDelivery>('POST', `/webhook_endpoints/${id}/send_test`, options),++ /** Re-enables an endpoint that was disabled (manually or after auto-disable). */+ enable: (id: string, options?: RequestOptions): Promise<WebhookEndpoint> =>+ this.request<WebhookEndpoint>('PATCH', `/webhook_endpoints/${id}/enable`, options),++ /** Manually disable an endpoint with an optional human-readable reason. */+ disable: (+ id: string,+ params?: WebhookEndpointDisableParams,+ options?: RequestOptions,+ ): Promise<WebhookEndpoint> =>+ this.request<WebhookEndpoint>('PATCH', `/webhook_endpoints/${id}/disable`, {+ ...options,+ body: params,+ }),++ deliveries: {+ list: (+ endpointId: string,+ params?: ListParams & Record<string, unknown>,+ options?: RequestOptions,+ ): Promise<PaginatedResponse<WebhookDelivery>> =>+ this.request<PaginatedResponse<WebhookDelivery>>(+ 'GET',+ `/webhook_endpoints/${endpointId}/deliveries`,+ { ...options, params: params ? transformListParams(params) : undefined },+ ),++ get: (endpointId: string, id: string, options?: RequestOptions): Promise<WebhookDelivery> =>+ this.request<WebhookDelivery>(+ 'GET',+ `/webhook_endpoints/${endpointId}/deliveries/${id}`,+ options,+ ),++ /**+ * Creates a new delivery row with the same payload + event_name and+ * queues it. The original row is preserved for audit history.+ */+ redeliver: (+ endpointId: string,+ id: string,+ options?: RequestOptions,+ ): Promise<WebhookDelivery> =>+ this.request<WebhookDelivery>(+ 'POST',+ `/webhook_endpoints/${endpointId}/deliveries/${id}/redeliver`,+ options,+ ),+ },+ }+// ============================================// Roles (read-only — for staff role pickers)// ============================================diff --git a/packages/admin-sdk/src/params.ts b/packages/admin-sdk/src/params.tsindex 6fca3d86dd..1441fc4737 100644--- a/packages/admin-sdk/src/params.ts+++ b/packages/admin-sdk/src/params.ts@@ -530,6 +530,33 @@ export interface AllowedOriginUpdateParams {origin?: string}+export interface WebhookEndpointCreateParams {+ /** Optional human label shown in the admin list view. */+ name?: string | null+ /** HTTPS destination URL. Cannot resolve to a private IP outside development. */+ url: string+ /** Defaults to true on create. Toggle with `disable`/`enable` for audit clarity. */+ active?: boolean+ /**+ * Event names this endpoint should receive. Empty array or `['*']` subscribes+ * to all events; otherwise list exact event names (e.g. `order.completed`) or+ * patterns (e.g. `order.*`).+ */+ subscriptions?: string[]+}++export interface WebhookEndpointUpdateParams {+ name?: string | null+ url?: string+ active?: boolean+ subscriptions?: string[]+}++export interface WebhookEndpointDisableParams {+ /** Optional human-readable reason shown next to the disabled indicator. */+ reason?: string+}+export interface TaxCategoryCreateParams {name: stringtax_code?: string | nulldiff --git a/packages/admin-sdk/src/types/generated/Store.ts b/packages/admin-sdk/src/types/generated/Store.tsindex 9c78212839..e6594de061 100644--- a/packages/admin-sdk/src/types/generated/Store.ts+++ b/packages/admin-sdk/src/types/generated/Store.ts@@ -1,4 +1,4 @@-// Typelizer digest 608d58eacf0255764ac3e6ddf74fd87b+// Typelizer digest 3c287129aed8cec6ab6d723141176664//// DO NOT MODIFY: This file was automatically generated by Typelizer.@@ -8,6 +8,10 @@ interface Store {name: string;default_currency: string;default_locale: string;+ mail_from_address: string | null;+ customer_support_email: string | null;+ new_order_notifications_email: string | null;+ preferred_send_consumer_transactional_emails: boolean;preferred_admin_locale: string | null;preferred_timezone: string;preferred_weight_unit: string;@@ -18,6 +22,7 @@ interface Store {supported_currencies: Array<string>;supported_locales: Array<string>;logo_url: string | null;+ mailer_logo_url: string | null;}export default Store;diff --git a/packages/admin-sdk/src/types/generated/WebhookDelivery.ts b/packages/admin-sdk/src/types/generated/WebhookDelivery.tsnew file mode 100644index 0000000000..88bf75a8cb--- /dev/null+++ b/packages/admin-sdk/src/types/generated/WebhookDelivery.ts@@ -0,0 +1,23 @@+// Typelizer digest 520a8371e25fe869ad529fcd906a9aec+//+// DO NOT MODIFY: This file was automatically generated by Typelizer.++interface WebhookDelivery {+ id: string;+ event_name: string;+ event_id: string | null;+ response_code: number | null;+ execution_time: number | null;+ error_type: string | null;+ request_errors: string | null;+ response_body: string | null;+ success: boolean | null;+ payload: Record<string, unknown>;+ created_at: string;+ updated_at: string;+ delivered_at: string | null;+ webhook_endpoint_id: string;+ webhook_endpoint_url: string;+}++export default WebhookDelivery;diff --git a/packages/admin-sdk/src/types/generated/WebhookEndpoint.ts b/packages/admin-sdk/src/types/generated/WebhookEndpoint.tsnew file mode 100644index 0000000000..1ea9aacb4e--- /dev/null+++ b/packages/admin-sdk/src/types/generated/WebhookEndpoint.ts@@ -0,0 +1,24 @@+// Typelizer digest dcc8ca70100301ec59e1980c825086ef+//+// DO NOT MODIFY: This file was automatically generated by Typelizer.++interface WebhookEndpoint {+ id: string;+ name: string | null;+ url: string;+ active: boolean;+ subscriptions: Array<string>;+ disabled_reason: string | null;+ created_at: string;+ updated_at: string;+ disabled_at: string | null;+ secret_key: string | null;+ last_delivery_at: string | null;+ recent_delivery_count: number;+ recent_failure_count: number;+ total_delivery_count: number;+ successful_delivery_count: number;+ failed_delivery_count: number;+}++export default WebhookEndpoint;diff --git a/packages/admin-sdk/src/types/generated/index.ts b/packages/admin-sdk/src/types/generated/index.tsindex 794d84d6de..5c62f349cf 100644--- a/packages/admin-sdk/src/types/generated/index.ts+++ b/packages/admin-sdk/src/types/generated/index.ts@@ -1,4 +1,4 @@-// Typelizer digest de3dae65f36f09d64272227132111491+// Typelizer digest b5f5b3915f8088d0f025fe621a24049d//// DO NOT MODIFY: This file was automatically generated by Typelizer.export type { default as Address } from './Address'@@ -56,3 +56,5 @@ export type { default as StoreCredit } from './StoreCredit'export type { default as Store } from './Store'export type { default as TaxCategory } from './TaxCategory'export type { default as Variant } from './Variant'+export type { default as WebhookDelivery } from './WebhookDelivery'+export type { default as WebhookEndpoint } from './WebhookEndpoint'diff --git a/packages/admin-sdk/src/types/index.ts b/packages/admin-sdk/src/types/index.tsindex 71023c051e..a1cf51c986 100644--- a/packages/admin-sdk/src/types/index.ts+++ b/packages/admin-sdk/src/types/index.ts@@ -64,3 +64,5 @@ export type { default as StoreCredit } from './generated/StoreCredit'export type { default as StoreCreditCategory } from './generated/StoreCreditCategory'export type { default as TaxCategory } from './generated/TaxCategory'export type { default as Variant } from './generated/Variant'+export type { default as WebhookDelivery } from './generated/WebhookDelivery'+export type { default as WebhookEndpoint } from './generated/WebhookEndpoint'diff --git a/packages/admin-sdk/tsconfig.tsbuildinfo b/packages/admin-sdk/tsconfig.tsbuildinfoindex af7b901d68..259ecd2608 100644--- a/packages/admin-sdk/tsconfig.tsbuildinfo+++ b/packages/admin-sdk/tsconfig.tsbuildinfo@@ -1 +1 @@-{"root":["./src/admin-client.ts","./src/client.ts","./src/index.ts","./src/params.ts","./src/types/index.ts","./src/types/generated/address.ts","./src/types/generated/adjustment.ts","./src/types/generated/adminuser.ts","./src/types/generated/allowedorigin.ts","./src/types/generated/apikey.ts","./src/types/generated/category.ts","./src/types/generated/country.ts","./src/types/generated/creditcard.ts","./src/types/generated/customfield.ts","./src/types/generated/customfielddefinition.ts","./src/types/generated/customer.ts","./src/types/generated/deliverymethod.ts","./src/types/generated/deliveryrate.ts","./src/types/generated/digitallink.ts","./src/types/generated/discount.ts","./src/types/generated/export.ts","./src/types/generated/fulfillment.ts","./src/types/generated/giftcard.ts","./src/types/generated/invitation.ts","./src/types/generated/lineitem.ts","./src/types/generated/market.ts","./src/types/generated/media.ts","./src/types/generated/optiontype.ts","./src/types/generated/optionvalue.ts","./src/types/generated/order.ts","./src/types/generated/payment.ts","./src/types/generated/paymentmethod.ts","./src/types/generated/paymentsource.ts","./src/types/generated/price.ts","./src/types/generated/pricehistory.ts","./src/types/generated/product.ts","./src/types/generated/refund.ts","./src/types/generated/reimbursement.ts","./src/types/generated/returnauthorization.ts","./src/types/generated/role.ts","./src/types/generated/state.ts","./src/types/generated/stockitem.ts","./src/types/generated/stocklocation.ts","./src/types/generated/stocktransfer.ts","./src/types/generated/store.ts","./src/types/generated/storecredit.ts","./src/types/generated/storecreditcategory.ts","./src/types/generated/taxcategory.ts","./src/types/generated/variant.ts","./src/types/generated/index.ts"],"version":"6.0.3"}\ No newline at end of file+{"root":["./src/admin-client.ts","./src/client.ts","./src/index.ts","./src/params.ts","./src/types/index.ts","./src/types/generated/address.ts","./src/types/generated/adjustment.ts","./src/types/generated/adminuser.ts","./src/types/generated/allowedorigin.ts","./src/types/generated/apikey.ts","./src/types/generated/category.ts","./src/types/generated/channel.ts","./src/types/generated/country.ts","./src/types/generated/couponcode.ts","./src/types/generated/creditcard.ts","./src/types/generated/customfield.ts","./src/types/generated/customfielddefinition.ts","./src/types/generated/customer.ts","./src/types/generated/customergroup.ts","./src/types/generated/deliverymethod.ts","./src/types/generated/deliveryrate.ts","./src/types/generated/digitallink.ts","./src/types/generated/discount.ts","./src/types/generated/export.ts","./src/types/generated/fulfillment.ts","./src/types/generated/giftcard.ts","./src/types/generated/giftcardbatch.ts","./src/types/generated/invitation.ts","./src/types/generated/lineitem.ts","./src/types/generated/market.ts","./src/types/generated/media.ts","./src/types/generated/optiontype.ts","./src/types/generated/optionvalue.ts","./src/types/generated/order.ts","./src/types/generated/payment.ts","./src/types/generated/paymentmethod.ts","./src/types/generated/paymentsource.ts","./src/types/generated/price.ts","./src/types/generated/pricehistory.ts","./src/types/generated/pricelist.ts","./src/types/generated/pricerule.ts","./src/types/generated/product.ts","./src/types/generated/productpublication.ts","./src/types/generated/promotion.ts","./src/types/generated/promotionaction.ts","./src/types/generated/promotionrule.ts","./src/types/generated/refund.ts","./src/types/generated/reimbursement.ts","./src/types/generated/returnauthorization.ts","./src/types/generated/role.ts","./src/types/generated/state.ts","./src/types/generated/stockitem.ts","./src/types/generated/stocklocation.ts","./src/types/generated/stockreservation.ts","./src/types/generated/stocktransfer.ts","./src/types/generated/store.ts","./src/types/generated/storecredit.ts","./src/types/generated/storecreditcategory.ts","./src/types/generated/taxcategory.ts","./src/types/generated/variant.ts","./src/types/generated/webhookdelivery.ts","./src/types/generated/webhookendpoint.ts","./src/types/generated/index.ts"],"version":"6.0.3"}\ No newline at end of filediff --git a/packages/dashboard-core/src/lib/permissions.ts b/packages/dashboard-core/src/lib/permissions.tsindex 6e2322a8c4..9c1f43e617 100644--- a/packages/dashboard-core/src/lib/permissions.ts+++ b/packages/dashboard-core/src/lib/permissions.ts@@ -34,6 +34,8 @@ export const Subject = {PromotionRule: 'Spree::PromotionRule',GiftCard: 'Spree::GiftCard',Market: 'Spree::Market',+ WebhookEndpoint: 'Spree::WebhookEndpoint',+ WebhookDelivery: 'Spree::WebhookDelivery',Wishlist: 'Spree::Wishlist',} as constdiff --git a/packages/dashboard-ui/src/index.ts b/packages/dashboard-ui/src/index.tsindex f65bee4d64..47c355d517 100644--- a/packages/dashboard-ui/src/index.ts+++ b/packages/dashboard-ui/src/index.ts@@ -28,15 +28,17 @@ export * from './spree/bulk-dialog'export * from './spree/calculator-summary'export * from './spree/color-picker'export * from './spree/confirm-dialog'+export * from './spree/copy-to-clipboard-button'export * from './spree/country-flag'export * from './spree/data-grid'export * from './spree/drag-handle'export * from './spree/form-actions'-// JsonPreviewDrawer is intentionally NOT re-exported from this barrel: it-// pulls in `@uiw/react-json-view` (~30KB gzip), and code-splitting only-// works when consumers can deep-import via `@spree/dashboard-ui/spree/json-preview-drawer`-// (the dashboard's `PageHeader` does this lazily). The type is available-// the same way — import { type JsonPreviewDrawerProps } from '@spree/dashboard-ui/spree/json-preview-drawer'.+// JsonPreviewDrawer and JsonValueView are intentionally NOT re-exported from+// this barrel: they pull in `@uiw/react-json-view` (~30KB gzip), and+// code-splitting only works when consumers can deep-import via+// `@spree/dashboard-ui/spree/json-preview-drawer` and+// `@spree/dashboard-ui/spree/json-value-view`. Types are available the same+// way — `import { type JsonPreviewDrawerProps } from '@spree/dashboard-ui/spree/json-preview-drawer'`.export * from './spree/metadata/metadata-card'export * from './spree/relative-time'diff --git a/packages/dashboard-ui/src/spree/copy-to-clipboard-button.tsx b/packages/dashboard-ui/src/spree/copy-to-clipboard-button.tsxnew file mode 100644index 0000000000..1d0ab10c88--- /dev/null+++ b/packages/dashboard-ui/src/spree/copy-to-clipboard-button.tsx@@ -0,0 +1,90 @@+import { CheckIcon, CopyIcon } from 'lucide-react'+import type { ComponentProps, ReactNode } from 'react'+import { useCopyToClipboard } from '../hooks/use-copy-to-clipboard'+import { cn } from '../lib/utils'+import { Button } from '../ui/button'++type ButtonProps = ComponentProps<typeof Button>++type CopyToClipboardButtonProps = Omit<ButtonProps, 'onClick' | 'children'> & {+ /** Text to write to the clipboard. */+ value: string+ /** Accessible label for the button — required by a11y rules. */+ 'aria-label': string+ /** Custom icon for the idle state. Defaults to `CopyIcon`. */+ icon?: ReactNode+ /** Custom icon for the copied state. Defaults to `CheckIcon`. */+ copiedIcon?: ReactNode+ /** Optional label rendered alongside the icon (e.g. "Copy"). */+ label?: ReactNode+ /** Optional label rendered alongside the icon while in the copied state. */+ copiedLabel?: ReactNode+ /**+ * How long the copied state stays true after a successful copy. Forwarded to+ * `useCopyToClipboard`. Defaults to 1200ms (the hook's default).+ */+ resetMs?: number+ /**+ * Stop the click event from bubbling. Useful inside `<ResourceTable>` rows+ * where `useRowClickBridge` would otherwise also fire. Defaults to `true`+ * since that's the common case — pass `false` to opt out.+ */+ stopPropagation?: boolean+}++/**+ * Universal copy-to-clipboard button. Renders a standard `<Button>` with a+ * copy icon that flips to a check icon for a short flash after a successful+ * copy. Forwards every `<Button>` prop except `onClick` + `children`, so the+ * caller controls variant, size, className, etc.+ *+ * @example Bare icon button next to a value+ * <span>+ * <code>{token}</code>+ * <CopyToClipboardButton value={token} aria-label="Copy token" size="icon-xs" variant="ghost" />+ * </span>+ *+ * @example Labelled button inside a modal+ * <CopyToClipboardButton+ * value={secret}+ * aria-label="Copy secret"+ * size="sm"+ * variant="outline"+ * label="Copy"+ * copiedLabel="Copied"+ * />+ */+export function CopyToClipboardButton({+ value,+ icon = <CopyIcon />,+ copiedIcon = <CheckIcon />,+ label,+ copiedLabel,+ resetMs,+ stopPropagation = true,+ className,+ size = 'icon-xs',+ variant = 'ghost',+ type = 'button',+ ...rest+}: CopyToClipboardButtonProps) {+ const { copied, copy } = useCopyToClipboard(resetMs !== undefined ? { resetMs } : undefined)+ const displayedLabel = copied && copiedLabel !== undefined ? copiedLabel : label++ return (+ <Button+ {...rest}+ type={type}+ size={size}+ variant={variant}+ className={cn(className)}+ onClick={(e) => {+ if (stopPropagation) e.stopPropagation()+ copy(value)+ }}+ >+ {copied ? copiedIcon : icon}+ {displayedLabel}+ </Button>+ )+}diff --git a/packages/dashboard-ui/src/spree/json-preview-drawer.tsx b/packages/dashboard-ui/src/spree/json-preview-drawer.tsxindex c8a2176f5f..0b185be69d 100644--- a/packages/dashboard-ui/src/spree/json-preview-drawer.tsx+++ b/packages/dashboard-ui/src/spree/json-preview-drawer.tsx@@ -8,9 +8,6 @@ import {SheetTitle,useCopyToClipboard,} from '@spree/dashboard-ui'-import { Link } from '@tanstack/react-router'-import JsonView from '@uiw/react-json-view'-import { vscodeTheme } from '@uiw/react-json-view/vscode'import {CheckIcon,ChevronDownIcon,@@ -24,28 +21,11 @@ import {import type { ComponentProps } from 'react'import { useEffect, useMemo, useState } from 'react'import { useTranslation } from 'react-i18next'+import { type JsonValueLinkResolver, JsonValueView } from './json-value-view'-/**- * Maps a string value (typically a prefixed ID like `or_abc123`) to an- * in-app route. Returned `to` is a `<Link to>` template; `params` is the- * positional-param map passed straight through. Return `null` for values- * that aren't linkable.- *- * The drawer doesn't ship with any built-in prefix conventions —- * `@spree/dashboard` provides Spree's `or`→orders / `prod`→products /- * `cus`→customers mapping at the call site so dashboard-ui stays- * Spree-vocabulary-free.- */-export type JsonValueLinkResolver = (- value: string,-) => { to: string; params: Record<string, string> } | null--const VALUE_TYPE_STYLES: Record<string, { color: string; format: (v: unknown) => string }> = {- string: { color: 'text-emerald-300', format: (v) => `"${v}"` },- number: { color: 'text-amber-300', format: String },- bigint: { color: 'text-amber-300', format: String },- boolean: { color: 'text-purple-300', format: String },-}+// Re-export so existing imports of `JsonValueLinkResolver` from this module+// keep working without touching call sites.+export type { JsonValueLinkResolver } from './json-value-view'export interface JsonPreviewDrawerProps {open: boolean@@ -215,23 +195,11 @@ export function JsonPreviewDrawer({<p className="text-zinc-500">Loading…</p>) : error ? (<p className="text-red-400">Failed to load: {error.message}</p>- ) : data ? (- <JsonView- value={data as object}- style={- { ...vscodeTheme, '--w-rjv-background-color': 'transparent' } as React.CSSProperties- }- collapsed={collapsed}- displayDataTypes={false}- displayObjectSize- enableClipboard- shortenTextAfterLength={60}- components={{- value: ({ value, type, ...rest }) => (- <ValueRenderer value={value} type={type} resolveLink={resolveLink} {...rest} />- ),- }}- />+ ) : data !== undefined ? (+ // The drawer paints its own dark surface around the renderer+ // (Sheet content + toolbar), so the view itself runs in `bare`+ // mode — no extra padding/background.+ <JsonValueView value={data} collapsed={collapsed} resolveLink={resolveLink} bare />) : null}</div></SheetContent>@@ -278,55 +246,3 @@ function DepthControl({</select>)}--interface ValueRendererProps {- value: unknown- type: string- resolveLink?: JsonValueLinkResolver-}--function ValueRenderer({- value,- type,- resolveLink,- ...rest-}: ValueRendererProps & React.HTMLAttributes<HTMLSpanElement>) {- if (type === 'string' && typeof value === 'string' && resolveLink) {- const resolved = resolveLink(value)- if (resolved) {- return (- <span {...rest} className="text-emerald-300">- "- <Link- to={resolved.to}- params={resolved.params}- className="text-emerald-300 underline decoration-emerald-700 hover:decoration-emerald-300 transition-colors"- onClick={(e) => e.stopPropagation()}- >- {value}- </Link>- "- </span>- )- }- }- return <JsonValueSpan value={value} type={type} {...rest} />-}--function JsonValueSpan({- value,- type,- ...rest-}: {- value: unknown- type: string-} & React.HTMLAttributes<HTMLSpanElement>) {- const style = value === null ? null : VALUE_TYPE_STYLES[type]- const color = value === null ? 'text-zinc-500' : (style?.color ?? 'text-zinc-300')- const display = value === null ? 'null' : style ? style.format(value) : String(value)- return (- <span {...rest} className={color}>- {display}- </span>- )-}diff --git a/packages/dashboard-ui/src/spree/json-value-view.tsx b/packages/dashboard-ui/src/spree/json-value-view.tsxnew file mode 100644index 0000000000..d764ccb427--- /dev/null+++ b/packages/dashboard-ui/src/spree/json-value-view.tsx@@ -0,0 +1,149 @@+import { Link } from '@tanstack/react-router'+import JsonView from '@uiw/react-json-view'+import { vscodeTheme } from '@uiw/react-json-view/vscode'+import { cn } from '../lib/utils'++/**+ * Maps a string value (typically a prefixed ID like `or_abc123`) to an+ * in-app route. Returned `to` is a `<Link to>` template; `params` is the+ * positional-param map passed straight through. Return `null` for values+ * that aren't linkable.+ *+ * No built-in prefix conventions ship with this component —+ * `@spree/dashboard` provides Spree's `or`→orders / `prod`→products /+ * `cus`→customers mapping at the call site so dashboard-ui stays+ * Spree-vocabulary-free.+ */+export type JsonValueLinkResolver = (+ value: string,+) => { to: string; params: Record<string, string> } | null++const VALUE_TYPE_STYLES: Record<string, { color: string; format: (v: unknown) => string }> = {+ string: { color: 'text-emerald-300', format: (v) => `"${v}"` },+ number: { color: 'text-amber-300', format: String },+ bigint: { color: 'text-amber-300', format: String },+ boolean: { color: 'text-purple-300', format: String },+}++export interface JsonValueViewProps {+ /** JSON-serializable data to render. */+ value: unknown+ /**+ * Collapse depth. `false` expands everything, `true` collapses everything,+ * a `number` collapses below that depth. Default `2`.+ */+ collapsed?: boolean | number+ /** Resolve prefixed-ID strings to in-app links. Omit for plain strings. */+ resolveLink?: JsonValueLinkResolver+ /** Class applied to the outer wrapper. The view always uses a dark theme so+ * give it a dark surface (e.g. `bg-zinc-950`) when embedding into a light+ * page; otherwise the syntax colours don't have enough contrast. */+ className?: string+ /** When true, renders no padding/background — useful when the parent already+ * owns the surface chrome (e.g. inside a `<Card>` with its own padding). */+ bare?: boolean+}++/**+ * Read-only JSON tree viewer with optional ID-to-link resolution. Built on+ * `@uiw/react-json-view` with a vscode-style theme. Pulls in ~30KB gzip of+ * dependencies, so consumers should lazy-load this component via+ * `React.lazy(() => import('@spree/dashboard-ui/spree/json-value-view'))`+ * if it isn't on the critical path.+ *+ * @example Inline preview inside a Card+ * <Card>+ * <CardContent className="bg-zinc-950">+ * <JsonValueView value={delivery.payload} bare />+ * </CardContent>+ * </Card>+ *+ * @example Linked prefixed IDs+ * <JsonValueView value={order} resolveLink={resolveSpreePrefixToRoute} />+ */+export function JsonValueView({+ value,+ collapsed = 2,+ resolveLink,+ className,+ bare = false,+}: JsonValueViewProps) {+ return (+ <div+ className={cn(+ 'font-mono text-sm',+ // The vscode theme is dark — when the parent doesn't already paint a+ // dark background, paint one here so the syntax colors stay legible.+ !bare && 'bg-zinc-950 text-zinc-100 rounded-md p-3',+ className,+ )}+ >+ <JsonView+ value={value as object}+ style={{ ...vscodeTheme, '--w-rjv-background-color': 'transparent' } as React.CSSProperties}+ collapsed={collapsed}+ displayDataTypes={false}+ displayObjectSize+ enableClipboard+ shortenTextAfterLength={60}+ components={{+ value: ({ value: v, type, ...rest }) => (+ <ValueRenderer value={v} type={type} resolveLink={resolveLink} {...rest} />+ ),+ }}+ />+ </div>+ )+}++interface ValueRendererProps {+ value: unknown+ type: string+ resolveLink?: JsonValueLinkResolver+}++function ValueRenderer({+ value,+ type,+ resolveLink,+ ...rest+}: ValueRendererProps & React.HTMLAttributes<HTMLSpanElement>) {+ if (type === 'string' && typeof value === 'string' && resolveLink) {+ const resolved = resolveLink(value)+ if (resolved) {+ return (+ <span {...rest} className="text-emerald-300">+ "+ <Link+ to={resolved.to}+ params={resolved.params}+ className="text-emerald-300 underline decoration-emerald-700 hover:decoration-emerald-300 transition-colors"+ onClick={(e) => e.stopPropagation()}+ >+ {value}+ </Link>+ "+ </span>+ )+ }+ }+ return <JsonValueSpan value={value} type={type} {...rest} />+}++function JsonValueSpan({+ value,+ type,+ ...rest+}: {+ value: unknown+ type: string+} & React.HTMLAttributes<HTMLSpanElement>) {+ const style = value === null ? null : VALUE_TYPE_STYLES[type]+ const color = value === null ? 'text-zinc-500' : (style?.color ?? 'text-zinc-300')+ const display = value === null ? 'null' : style ? style.format(value) : String(value)+ return (+ <span {...rest} className={color}>+ {display}+ </span>+ )+}diff --git a/packages/dashboard/e2e/webhooks.spec.ts b/packages/dashboard/e2e/webhooks.spec.tsnew file mode 100644index 0000000000..4d5d0c9500--- /dev/null+++ b/packages/dashboard/e2e/webhooks.spec.ts@@ -0,0 +1,169 @@+import { expect, type Page, test } from '@playwright/test'+import { gotoIndex, login, openRowMenu, rowButton } from './helpers'++const WEBHOOKS_PATH = (storeId: string) => `/${storeId}/settings/webhooks`+const CTA = /new endpoint/i++async function createEndpoint(+ page: Page,+ opts: { name: string; url: string; pickEvents?: string[] },+) {+ await page.getByRole('button', { name: CTA }).click()+ await expect(page.getByRole('heading', { name: /add webhook endpoint/i })).toBeVisible()++ await page.locator('#webhook-name').fill(opts.name)+ await page.locator('#webhook-url').fill(opts.url)++ // Each event row renders a `<label htmlFor="webhook-event-<slug>">`. We+ // address them via their accessible label, which is the event name itself.+ for (const ev of opts.pickEvents ?? []) {+ await page.getByLabel(ev, { exact: true }).check()+ }++ // The Sheet footer renders just "Cancel" + "Create". Match the latter.+ await page+ .locator('[role="dialog"]')+ .getByRole('button', { name: /^create$/i })+ .click()+}++test.describe.configure({ mode: 'serial' })++test.describe('webhooks', () => {+ test('lists webhook endpoints', async ({ page }) => {+ const creds = await login(page)+ await gotoIndex(page, WEBHOOKS_PATH(creds.store_id), CTA)+ })++ test('creates an endpoint, reveals the secret, and navigates to its detail page', async ({+ page,+ }) => {+ const creds = await login(page)+ await gotoIndex(page, WEBHOOKS_PATH(creds.store_id), CTA)++ const suffix = Date.now()+ const name = `E2E Webhook ${suffix}`+ const url = `https://e2e-${suffix}.example.com/webhooks`++ await createEndpoint(page, {+ name,+ url,+ pickEvents: ['order.completed', 'order.canceled'],+ })++ // One-shot "Save your signing secret" dialog. The reveal is the proof+ // that create returned `secret_key` — that's the response contract.+ await expect(page.getByRole('heading', { name: /save your signing secret/i })).toBeVisible({+ timeout: 15_000,+ })+ await page.getByRole('button', { name: /^done$/i }).click()++ // After dismissing the secret reveal the user lands on the new endpoint's+ // detail page (see `SecretRevealDialog.onOpenChange` in webhooks.tsx).+ await expect(page).toHaveURL(/\/settings\/webhooks\/whe_/, { timeout: 15_000 })+ await expect(page.getByRole('heading', { name })).toBeVisible({ timeout: 15_000 })++ // Going back to the index, the endpoint shows up in the list — proves+ // cache invalidation across the route change.+ await page.goto(WEBHOOKS_PATH(creds.store_id))+ await expect(rowButton(page, name)).toBeVisible({ timeout: 15_000 })+ })++ test('clicking the name navigates to the detail page', async ({ page }) => {+ const creds = await login(page)+ await gotoIndex(page, WEBHOOKS_PATH(creds.store_id), CTA)++ const suffix = Date.now()+ const name = `E2E Edit ${suffix}`+ const url = `https://edit-${suffix}.example.com/hook`++ await createEndpoint(page, { name, url, pickEvents: ['order.completed'] })+ // Skip the secret-reveal redirect: dismiss the dialog *and* go back to+ // the index so we can click the row.+ await page.getByRole('button', { name: /^done$/i }).click()+ await page.goto(WEBHOOKS_PATH(creds.store_id))+ await expect(rowButton(page, name)).toBeVisible({ timeout: 15_000 })++ await rowButton(page, name).click()+ await expect(page).toHaveURL(/\/settings\/webhooks\/whe_/, { timeout: 15_000 })+ await expect(page.getByRole('heading', { name })).toBeVisible({ timeout: 15_000 })+ await expect(page.locator('#webhook-name')).toHaveValue(name)+ await expect(page.locator('#webhook-url')).toHaveValue(url)+ })++ test('renames an endpoint on its detail page', async ({ page }) => {+ const creds = await login(page)+ await gotoIndex(page, WEBHOOKS_PATH(creds.store_id), CTA)++ const suffix = Date.now()+ const original = `E2E Rename ${suffix}`+ const updated = `${original} (renamed)`+ const url = `https://rename-${suffix}.example.com/hook`++ await createEndpoint(page, { name: original, url, pickEvents: ['order.completed'] })+ // After the secret-reveal Done we're already on the detail page.+ await page.getByRole('button', { name: /^done$/i }).click()+ await expect(page.locator('#webhook-name')).toHaveValue(original, { timeout: 15_000 })++ await page.locator('#webhook-name').fill(updated)+ await page.getByRole('button', { name: /^save$/i }).click()++ // The header title also reflects the new name once the mutation completes+ // (the form revalidates from the cached endpoint and the detail body+ // refetches on invalidation).+ await expect(page.getByRole('heading', { name: updated })).toBeVisible({ timeout: 15_000 })+ })++ test('sends a test delivery and surfaces it in the embedded deliveries list', async ({+ page,+ }) => {+ const creds = await login(page)+ await gotoIndex(page, WEBHOOKS_PATH(creds.store_id), CTA)++ const suffix = Date.now()+ const name = `E2E Test Send ${suffix}`+ const url = `https://test-${suffix}.example.com/hook`++ await createEndpoint(page, { name, url, pickEvents: ['order.completed'] })+ await page.getByRole('button', { name: /^done$/i }).click()++ // We're on the detail page after the secret-reveal redirect. The "Send+ // test" header button replaces the row kebab menu entry from before.+ await expect(page.getByRole('heading', { name })).toBeVisible({ timeout: 15_000 })+ await page.getByRole('button', { name: /send test/i }).click()++ // Toast confirmation.+ await expect(page.getByText(/test webhook queued/i)).toBeVisible({ timeout: 10_000 })++ // The embedded deliveries `<ResourceTable>` refetches via the+ // useSendTestWebhook invalidation, so a `webhook.test` row appears+ // without a manual refresh.+ await expect(page.getByText('webhook.test', { exact: true }).first()).toBeVisible({+ timeout: 15_000,+ })+ })++ test('deletes an endpoint via the row confirm dialog', async ({ page }) => {+ const creds = await login(page)+ await gotoIndex(page, WEBHOOKS_PATH(creds.store_id), CTA)++ const suffix = Date.now()+ const name = `E2E Delete ${suffix}`+ const url = `https://del-${suffix}.example.com/hook`++ await createEndpoint(page, { name, url, pickEvents: ['order.completed'] })+ await page.getByRole('button', { name: /^done$/i }).click()+ await page.goto(WEBHOOKS_PATH(creds.store_id))+ await expect(rowButton(page, name)).toBeVisible({ timeout: 15_000 })++ await openRowMenu(page, name)+ await page.getByRole('menuitem', { name: /^delete$/i }).click()+ await expect(page.getByRole('heading', { name: /delete webhook endpoint\?/i })).toBeVisible()+ await page+ .getByRole('dialog')+ .getByRole('button', { name: /^delete$/i })+ .click()++ await expect(rowButton(page, name)).toHaveCount(0, { timeout: 15_000 })+ })+})diff --git a/packages/dashboard/src/components/spree/webhook-endpoint-form.tsx b/packages/dashboard/src/components/spree/webhook-endpoint-form.tsxnew file mode 100644index 0000000000..bbe8483492--- /dev/null+++ b/packages/dashboard/src/components/spree/webhook-endpoint-form.tsx@@ -0,0 +1,166 @@+import {+ Badge,+ Checkbox,+ Field,+ FieldDescription,+ FieldError,+ FieldLabel,+ Input,+ Switch,+} from '@spree/dashboard-ui'+import { Controller, type UseFormReturn } from 'react-hook-form'+import { useTranslation } from 'react-i18next'+import { WEBHOOK_EVENT_GROUPS, type WebhookEndpointFormValues } from '@/schemas/webhook-endpoint'++/**+ * The webhook endpoint form fields — Name / URL / Active toggle / Events+ * picker. Used both by the Create sheet on the index page and the Edit card+ * on the endpoint detail route, so changes stay in sync.+ *+ * Drive submission from the caller — this component is purely the field set,+ * not the form wrapper.+ */+export function WebhookEndpointFormFields({+ form,+}: {+ form: UseFormReturn<WebhookEndpointFormValues>+}) {+ const { t } = useTranslation()+ const { errors } = form.formState++ return (+ <>+ {errors.root?.message && (+ <p className="text-sm text-destructive" role="alert">+ {errors.root.message}+ </p>+ )}++ <Field>+ <FieldLabel htmlFor="webhook-name">+ {t('admin.fields.webhook_endpoint.name.label')}+ </FieldLabel>+ <Input+ id="webhook-name"+ placeholder={t('admin.fields.webhook_endpoint.name.placeholder')}+ aria-invalid={!!errors.name || undefined}+ {...form.register('name')}+ />+ <FieldDescription>{t('admin.fields.webhook_endpoint.name.help')}</FieldDescription>+ <FieldError errors={[errors.name]} />+ </Field>++ <Field>+ <FieldLabel htmlFor="webhook-url">+ {t('admin.fields.webhook_endpoint.url.label')}+ </FieldLabel>+ <Input+ id="webhook-url"+ type="url"+ placeholder={t('admin.fields.webhook_endpoint.url.placeholder')}+ aria-invalid={!!errors.url || undefined}+ {...form.register('url')}+ />+ <FieldError errors={[errors.url]} />+ </Field>++ <Field>+ <div className="flex items-start justify-between gap-4">+ <div className="flex flex-col">+ <FieldLabel htmlFor="webhook-active" className="cursor-pointer">+ {t('admin.fields.webhook_endpoint.active.label')}+ </FieldLabel>+ <FieldDescription>{t('admin.fields.webhook_endpoint.active.help')}</FieldDescription>+ </div>+ <Controller+ name="active"+ control={form.control}+ render={({ field }) => (+ <Switch id="webhook-active" checked={field.value} onCheckedChange={field.onChange} />+ )}+ />+ </div>+ </Field>++ <Field>+ <FieldLabel>{t('admin.fields.webhook_endpoint.subscriptions.label')}</FieldLabel>+ <FieldDescription>{t('admin.fields.webhook_endpoint.subscriptions.help')}</FieldDescription>+ <Controller+ name="subscriptions"+ control={form.control}+ render={({ field }) => <EventPicker value={field.value} onChange={field.onChange} />}+ />+ </Field>+ </>+ )+}++function EventPicker({ value, onChange }: { value: string[]; onChange: (next: string[]) => void }) {+ const { t } = useTranslation()+ const allBuiltIn = WEBHOOK_EVENT_GROUPS.flatMap((g) => g.events)+ const customEvents = value.filter((e) => !allBuiltIn.includes(e))++ function toggle(event: string) {+ onChange(value.includes(event) ? value.filter((e) => e !== event) : [...value, event])+ }++ return (+ <div className="flex flex-col gap-3 rounded-md border border-border">+ <div className="border-b border-border bg-muted/30 p-3 text-xs text-muted-foreground">+ {value.length === 0+ ? t('admin.pages.settings.webhooks.events_all')+ : t('admin.pages.settings.webhooks.events_count', { count: value.length })}+ </div>+ <div className="flex max-h-72 flex-col gap-4 overflow-y-auto p-3">+ {WEBHOOK_EVENT_GROUPS.map((group) => (+ <div key={group.labelKey} className="flex flex-col gap-1">+ <span className="text-xs font-medium tracking-wide text-muted-foreground uppercase">+ {t(group.labelKey)}+ </span>+ <div className="grid grid-cols-1 gap-1 sm:grid-cols-2">+ {group.events.map((event) => {+ const checkboxId = `webhook-event-${event.replace(/[^a-z0-9]/gi, '-')}`+ return (+ <label+ key={event}+ htmlFor={checkboxId}+ className="flex cursor-pointer items-center gap-2 rounded p-1 text-sm hover:bg-accent"+ >+ <Checkbox+ id={checkboxId}+ checked={value.includes(event)}+ onCheckedChange={() => toggle(event)}+ />+ <span className="font-mono text-xs">{event}</span>+ </label>+ )+ })}+ </div>+ </div>+ ))}+ {customEvents.length > 0 && (+ <div className="flex flex-col gap-1">+ <span className="text-xs font-medium tracking-wide text-muted-foreground uppercase">+ {t('admin.pages.settings.webhooks.event_groups.custom')}+ </span>+ <div className="flex flex-wrap gap-1.5">+ {customEvents.map((event) => (+ <Badge key={event} variant="secondary" className="font-mono">+ {event}+ <button+ type="button"+ onClick={() => toggle(event)}+ className="ml-1.5 text-muted-foreground hover:text-destructive"+ aria-label={t('admin.pages.settings.webhooks.events_remove_aria', { event })}+ >+ ×+ </button>+ </Badge>+ ))}+ </div>+ </div>+ )}+ </div>+ </div>+ )+}diff --git a/packages/dashboard/src/hooks/use-webhook-endpoints.ts b/packages/dashboard/src/hooks/use-webhook-endpoints.tsnew file mode 100644index 0000000000..9961d264c8--- /dev/null+++ b/packages/dashboard/src/hooks/use-webhook-endpoints.ts@@ -0,0 +1,143 @@+import type {+ WebhookDelivery,+ WebhookEndpoint,+ WebhookEndpointCreateParams,+ WebhookEndpointUpdateParams,+} from '@spree/admin-sdk'+import { adminClient, useResourceMutation, useStore } from '@spree/dashboard-core'+import { useQuery, useQueryClient } from '@tanstack/react-query'++// `webhookEndpointsListKey` is what `<ResourceTable queryKey="webhook-endpoints">`+// uses internally as the prefix of its compound key (`['webhook-endpoints',+// { page, limit, sort, search, filters }]`). Invalidating the bare prefix is+// what gets the table to refetch — anything more specific misses.+//+// Detail/deliveries queries below carry `storeId` so switching stores invalidates+// cached single-endpoint data; the list query is owned by ResourceTable, which+// remounts when the route changes, so it doesn't need explicit store-scoping.+export const webhookEndpointsListKey = ['webhook-endpoints'] as const++export function useWebhookEndpointQueryKey(id: string | undefined) {+ const { storeId } = useStore()+ return ['webhook-endpoints', storeId, id ?? 'noop'] as const+}++export function useWebhookDeliveriesQueryKey(endpointId: string | undefined) {+ const { storeId } = useStore()+ return ['webhook-endpoints', storeId, endpointId ?? 'noop', 'deliveries'] as const+}++export function useWebhookEndpoint(id: string | undefined) {+ const key = useWebhookEndpointQueryKey(id)+ return useQuery({+ queryKey: key,+ queryFn: () => adminClient.webhookEndpoints.get(id as string),+ enabled: !!id,+ })+}++export function useCreateWebhookEndpoint() {+ return useResourceMutation<WebhookEndpoint, Error, WebhookEndpointCreateParams>({+ mutationFn: (params) => adminClient.webhookEndpoints.create(params),+ invalidate: [webhookEndpointsListKey],+ // The creator wants the dedicated "save your secret" sheet, not a toast,+ // because the secret_key in the response is only revealed once.+ successMessage: false,+ errorMessage: 'Failed to create webhook endpoint',+ })+}++export function useUpdateWebhookEndpoint(id: string) {+ const detailKey = useWebhookEndpointQueryKey(id)++ return useResourceMutation<WebhookEndpoint, Error, WebhookEndpointUpdateParams>({+ mutationFn: (params) => adminClient.webhookEndpoints.update(id, params),+ invalidate: [webhookEndpointsListKey, detailKey],+ successMessage: 'Webhook endpoint updated',+ errorMessage: 'Failed to update webhook endpoint',+ })+}++export function useDeleteWebhookEndpoint() {+ const queryClient = useQueryClient()+ const { storeId } = useStore()++ return useResourceMutation<void, Error, string>({+ mutationFn: (id) => adminClient.webhookEndpoints.delete(id),+ invalidate: [webhookEndpointsListKey],+ successMessage: 'Webhook endpoint removed',+ errorMessage: 'Failed to remove webhook endpoint',+ onSuccess: (_data, id) => {+ queryClient.removeQueries({+ queryKey: ['webhook-endpoints', storeId, id],+ })+ },+ })+}++export function useToggleWebhookEndpoint() {+ const queryClient = useQueryClient()+ const { storeId } = useStore()++ return useResourceMutation<WebhookEndpoint, Error, { id: string; active: boolean }>({+ mutationFn: ({ id, active }) =>+ active ? adminClient.webhookEndpoints.enable(id) : adminClient.webhookEndpoints.disable(id),+ invalidate: [webhookEndpointsListKey],+ successMessage: false,+ errorMessage: 'Failed to update endpoint',+ onSuccess: (_data, { id }) => {+ // The detail page reads `disabled_at` + `active` directly from the+ // single-endpoint cache; invalidating only the list misses it.+ queryClient.invalidateQueries({+ queryKey: ['webhook-endpoints', storeId, id],+ })+ },+ })+}++export function useSendTestWebhook() {+ const queryClient = useQueryClient()+ const { storeId } = useStore()++ return useResourceMutation<WebhookDelivery, Error, string>({+ mutationFn: (id) => adminClient.webhookEndpoints.sendTest(id),+ successMessage: false,+ errorMessage: 'Failed to send test webhook',+ onSuccess: (_data, endpointId) => {+ // Refetch the deliveries list for the endpoint we just tested so the new+ // row appears without needing a manual refresh. The mutation is passed+ // the endpoint id as its variable, so we can derive the right key here.+ queryClient.invalidateQueries({+ queryKey: ['webhook-endpoints', storeId, endpointId, 'deliveries'],+ })+ },+ })+}++export function useWebhookDelivery(endpointId: string | undefined, deliveryId: string | undefined) {+ const { storeId } = useStore()+ return useQuery({+ queryKey: [+ 'webhook-endpoints',+ storeId,+ endpointId ?? 'noop',+ 'deliveries',+ deliveryId ?? 'noop',+ ] as const,+ queryFn: () =>+ adminClient.webhookEndpoints.deliveries.get(endpointId as string, deliveryId as string),+ enabled: !!endpointId && !!deliveryId,+ })+}++export function useRedeliverWebhookDelivery(endpointId: string) {+ const deliveriesKey = useWebhookDeliveriesQueryKey(endpointId)++ return useResourceMutation<WebhookDelivery, Error, string>({+ mutationFn: (deliveryId) =>+ adminClient.webhookEndpoints.deliveries.redeliver(endpointId, deliveryId),+ invalidate: [deliveriesKey],+ successMessage: false,+ errorMessage: 'Failed to redeliver',+ })+}diff --git a/packages/dashboard/src/lib/webhook-health.ts b/packages/dashboard/src/lib/webhook-health.tsnew file mode 100644index 0000000000..1de4990528--- /dev/null+++ b/packages/dashboard/src/lib/webhook-health.ts@@ -0,0 +1,42 @@+import type { WebhookEndpoint } from '@spree/admin-sdk'++export type WebhookHealthBucket =+ | { kind: 'disabled' }+ | { kind: 'no_deliveries' }+ | { kind: 'healthy' | 'degraded' | 'failing'; percentage: number }++/**+ * Mirrors `webhook_endpoint_health_badge` from+ * `spree/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb` so the SPA+ * and the legacy admin agree on what counts as healthy/degraded/failing.+ *+ * Thresholds: ≥95% success → healthy, ≥80% → degraded, otherwise failing.+ */+export function webhookEndpointHealth(endpoint: WebhookEndpoint): WebhookHealthBucket {+ if (endpoint.disabled_at) return { kind: 'disabled' }++ const total = endpoint.total_delivery_count ?? 0+ if (total === 0) return { kind: 'no_deliveries' }++ const successful = endpoint.successful_delivery_count ?? 0+ const percentage = Math.round((successful / total) * 10000) / 100++ if (percentage >= 95) return { kind: 'healthy', percentage }+ if (percentage >= 80) return { kind: 'degraded', percentage }+ return { kind: 'failing', percentage }+}++export function webhookHealthBadgeVariant(+ bucket: WebhookHealthBucket,+): 'default' | 'secondary' | 'destructive' {+ switch (bucket.kind) {+ case 'healthy':+ return 'default'+ case 'degraded':+ case 'no_deliveries':+ return 'secondary'+ case 'failing':+ case 'disabled':+ return 'destructive'+ }+}diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.jsonindex 90d07a2ff2..8f80aab41e 100644--- a/packages/dashboard/src/locales/en.json+++ b/packages/dashboard/src/locales/en.json@@ -429,6 +429,23 @@},"preferred_weight_unit": {"label": "Weight unit"+ "webhook_endpoint": {+ "name": {+ "label": "Name",+ "placeholder": "e.g. Order pipeline",+ "help": "Optional label shown in this list."+ },+ "url": {+ "label": "Destination URL",+ "placeholder": "https://example.com/webhooks"+ },+ "active": {+ "label": "Active",+ "help": "Inactive endpoints don't receive deliveries."+ },+ "subscriptions": {+ "label": "Events",+ "help": "Select which events should trigger a webhook. Choose nothing to receive every event."}},"product": {@@ -1016,6 +1033,144 @@"tab_general": "General","tab_standards": "Standards and formats"},+ "webhooks": {+ "title": "Webhooks",+ "subtitle": "Subscribe HTTPS endpoints to events fired by your store.",+ "search_placeholder": "Search by URL…",+ "new_cta": "New endpoint",+ "empty_title": "No webhook endpoints yet",+ "empty_description": "Create an endpoint to receive a signed POST every time a subscribed event fires.",+ "add_sheet_title": "Add webhook endpoint",+ "edit_sheet_title": "Edit webhook endpoint",+ "deliveries_sheet_title": "Recent deliveries",+ "delete_confirm": {+ "title": "Delete webhook endpoint?",+ "message": "{{name}} will stop receiving deliveries immediately. Past delivery history is also removed."+ },+ "detail": {+ "load_failed_title": "Couldn't load this webhook endpoint",+ "delete_label": "Delete endpoint",+ "details_title": "Details",+ "edit_title": "Edit endpoint",+ "url": "Destination URL",+ "subscriptions": "Events",+ "created_at": "Created at",+ "updated_at": "Updated at"+ },+ "save_secret_title": "Save your signing secret",+ "save_secret_description": "Verify incoming webhook signatures with this key. We won't show it again.",+ "actions": {+ "send_test": "Send test",+ "disable": "Disable",+ "enable": "Re-enable",+ "view_deliveries": "View deliveries",+ "redeliver": "Redeliver"+ },+ "status": {+ "active": "Active",+ "inactive": "Inactive",+ "disabled": "Auto-disabled",+ "disabled_reason": "Disabled: {{reason}}"+ },+ "health": {+ "label": "Health",+ "healthy": "Healthy ({{percentage}}%)",+ "degraded": "Degraded ({{percentage}}%)",+ "failing": "Failing ({{percentage}}%)",+ "disabled": "Disabled",+ "no_deliveries": "No deliveries yet",+ "auto_disabled_alert": "This endpoint was automatically disabled after repeated delivery failures.",+ "re_enable_cta": "Re-enable",+ "metric_total": "Deliveries",+ "metric_successful": "Successful",+ "metric_failed": "Failed",+ "row_counters_successful_one": "{{count}} successful",+ "row_counters_successful_other": "{{count}} successful",+ "row_counters_failed_one": "{{count}} failed",+ "row_counters_failed_other": "{{count}} failed"+ },+ "table": {+ "name": "Name",+ "url": "URL",+ "events": "Events",+ "status": "Status",+ "recent_deliveries": "Last 7 days",+ "last_delivery": "Last delivery",+ "copy_url_aria": "Copy URL"+ },+ "events_all": "All events",+ "events_count_one": "{{count}} event",+ "events_count_other": "{{count}} events",+ "events_custom_input_placeholder": "custom.event_name",+ "events_add_cta": "Add",+ "events_remove_aria": "Remove {{event}}",+ "event_groups": {+ "asset": "Asset",+ "custom": "Custom",+ "customer": "Customer",+ "digital": "Digital",+ "gift_card": "Gift card",+ "gift_card_batch": "Gift card batch",+ "import_export": "Import / Export",+ "invitation": "Invitation",+ "line_item": "Line item",+ "newsletter_subscriber": "Newsletter subscriber",+ "order": "Order",+ "payment": "Payment",+ "payment_session": "Payment session",+ "payment_setup_session": "Payment setup session",+ "price": "Price",+ "product": "Product",+ "promotion": "Promotion",+ "refund": "Refund",+ "report": "Report",+ "return": "Return",+ "shipment": "Shipment",+ "stock_item": "Stock item",+ "stock_movement": "Stock movement",+ "stock_reservation": "Stock reservation",+ "stock_transfer": "Stock transfer",+ "store_credit": "Store credit",+ "variant": "Variant",+ "wishlist": "Wishlist"+ },+ "deliveries": {+ "table": {+ "event": "Event",+ "status": "Status",+ "code": "Response",+ "execution_time": "Duration",+ "delivered_at": "Delivered at"+ },+ "status": {+ "pending": "Pending",+ "success": "Succeeded",+ "failure": "Failed",+ "error": "Error"+ },+ "empty": "No deliveries yet — send a test to verify your endpoint.",+ "search_placeholder": "Search by event name…",+ "test_sent": "Test webhook queued.",+ "test_failed": "Failed to send test webhook.",+ "redeliver_queued": "Redelivery queued.",+ "detail_sheet_title": "Delivery details",+ "detail": {+ "event": "Event",+ "status": "Status",+ "url": "Destination URL",+ "delivered_at": "Delivered at",+ "response_code": "Response code",+ "execution_time": "Execution time",+ "error_type": "Error type",+ "request_errors": "Transport error",+ "request_payload": "Request payload",+ "response_body": "Response body",+ "response_body_truncated": "Response body was truncated to {{limit}} characters.",+ "copy_payload_aria": "Copy request payload",+ "copy_response_aria": "Copy response body"+ }+ }+ },"api_keys": {"title": "API keys","subtitle": "Authorize integrations and apps to call the Admin API.",diff --git a/packages/dashboard/src/nav/settings.ts b/packages/dashboard/src/nav/settings.tsindex a5e8c132dc..a80b701427 100644--- a/packages/dashboard/src/nav/settings.ts+++ b/packages/dashboard/src/nav/settings.ts@@ -10,6 +10,7 @@ import {TagIcon,UsersRoundIcon,WarehouseIcon,+ WebhookIcon,} from 'lucide-react'settingsNav.addGroup({ key: 'store', label: 'Store', position: 100 })@@ -107,6 +108,16 @@ settingsNav.add({subject: Subject.ApiKey,})+settingsNav.add({+ key: 'settings.webhooks',+ label: 'Webhooks',+ path: '/webhooks',+ icon: WebhookIcon,+ group: 'team',+ position: 250,+ subject: Subject.WebhookEndpoint,+})+settingsNav.add({key: 'settings.allowed-origins',label: 'Allowed origins',diff --git a/packages/dashboard/src/routeTree.gen.ts b/packages/dashboard/src/routeTree.gen.tsindex dd329d3b16..7ad5396e2e 100644--- a/packages/dashboard/src/routeTree.gen.ts+++ b/packages/dashboard/src/routeTree.gen.ts@@ -43,7 +43,9 @@ import { Route as AuthenticatedStoreIdOrdersDraftsRouteImport } from './routes/_import { Route as AuthenticatedStoreIdOrdersOrderIdRouteImport } from './routes/_authenticated/$storeId/orders/$orderId'import { Route as AuthenticatedStoreIdCustomersGroupsRouteImport } from './routes/_authenticated/$storeId/customers/groups'import { Route as AuthenticatedStoreIdCustomersCustomerIdRouteImport } from './routes/_authenticated/$storeId/customers/$customerId'+import { Route as AuthenticatedStoreIdSettingsWebhooksIndexRouteImport } from './routes/_authenticated/$storeId/settings/webhooks/index'import { Route as AuthenticatedStoreIdProductsPriceListsIndexRouteImport } from './routes/_authenticated/$storeId/products/price-lists/index'+import { Route as AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRouteImport } from './routes/_authenticated/$storeId/settings/webhooks/$webhookEndpointId'import { Route as AuthenticatedStoreIdProductsPriceListsNewRouteImport } from './routes/_authenticated/$storeId/products/price-lists/new'import { Route as AuthenticatedStoreIdProductsPriceListsPriceListIdIndexRouteImport } from './routes/_authenticated/$storeId/products/price-lists/$priceListId/index'@@ -246,12 +248,24 @@ const AuthenticatedStoreIdCustomersCustomerIdRoute =path: '/customers/$customerId',getParentRoute: () => AuthenticatedStoreIdRoute,} as any)+const AuthenticatedStoreIdSettingsWebhooksIndexRoute =+ AuthenticatedStoreIdSettingsWebhooksIndexRouteImport.update({+ id: '/webhooks/',+ path: '/webhooks/',+ getParentRoute: () => AuthenticatedStoreIdSettingsRoute,+ } as any)const AuthenticatedStoreIdProductsPriceListsIndexRoute =AuthenticatedStoreIdProductsPriceListsIndexRouteImport.update({id: '/products/price-lists/',path: '/products/price-lists/',getParentRoute: () => AuthenticatedStoreIdRoute,} as any)+const AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute =+ AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRouteImport.update({+ id: '/webhooks/$webhookEndpointId',+ path: '/webhooks/$webhookEndpointId',+ getParentRoute: () => AuthenticatedStoreIdSettingsRoute,+ } as any)const AuthenticatedStoreIdProductsPriceListsNewRoute =AuthenticatedStoreIdProductsPriceListsNewRouteImport.update({id: '/products/price-lists/new',@@ -288,6 +302,7 @@ export interface FileRoutesByFullPath {'/$storeId/settings/api-keys': typeof AuthenticatedStoreIdSettingsApiKeysRoute'/$storeId/settings/channels': typeof AuthenticatedStoreIdSettingsChannelsRoute'/$storeId/settings/custom-field-definitions': typeof AuthenticatedStoreIdSettingsCustomFieldDefinitionsRoute+ '/$storeId/settings/emails': typeof AuthenticatedStoreIdSettingsEmailsRoute'/$storeId/settings/markets': typeof AuthenticatedStoreIdSettingsMarketsRoute'/$storeId/settings/payment-methods': typeof AuthenticatedStoreIdSettingsPaymentMethodsRoute'/$storeId/settings/staff': typeof AuthenticatedStoreIdSettingsStaffRoute@@ -300,7 +315,9 @@ export interface FileRoutesByFullPath {'/$storeId/promotions/': typeof AuthenticatedStoreIdPromotionsIndexRoute'/$storeId/settings/': typeof AuthenticatedStoreIdSettingsIndexRoute'/$storeId/products/price-lists/new': typeof AuthenticatedStoreIdProductsPriceListsNewRoute+ '/$storeId/settings/webhooks/$webhookEndpointId': typeof AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute'/$storeId/products/price-lists/': typeof AuthenticatedStoreIdProductsPriceListsIndexRoute+ '/$storeId/settings/webhooks/': typeof AuthenticatedStoreIdSettingsWebhooksIndexRoute'/$storeId/products/price-lists/$priceListId/': typeof AuthenticatedStoreIdProductsPriceListsPriceListIdIndexRoute}export interface FileRoutesByTo {@@ -336,7 +353,9 @@ export interface FileRoutesByTo {'/$storeId/promotions': typeof AuthenticatedStoreIdPromotionsIndexRoute'/$storeId/settings': typeof AuthenticatedStoreIdSettingsIndexRoute'/$storeId/products/price-lists/new': typeof AuthenticatedStoreIdProductsPriceListsNewRoute+ '/$storeId/settings/webhooks/$webhookEndpointId': typeof AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute'/$storeId/products/price-lists': typeof AuthenticatedStoreIdProductsPriceListsIndexRoute+ '/$storeId/settings/webhooks': typeof AuthenticatedStoreIdSettingsWebhooksIndexRoute'/$storeId/products/price-lists/$priceListId': typeof AuthenticatedStoreIdProductsPriceListsPriceListIdIndexRoute}export interface FileRoutesById {@@ -376,7 +395,9 @@ export interface FileRoutesById {'/_authenticated/$storeId/promotions/': typeof AuthenticatedStoreIdPromotionsIndexRoute'/_authenticated/$storeId/settings/': typeof AuthenticatedStoreIdSettingsIndexRoute'/_authenticated/$storeId/products/price-lists/new': typeof AuthenticatedStoreIdProductsPriceListsNewRoute+ '/_authenticated/$storeId/settings/webhooks/$webhookEndpointId': typeof AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute'/_authenticated/$storeId/products/price-lists/': typeof AuthenticatedStoreIdProductsPriceListsIndexRoute+ '/_authenticated/$storeId/settings/webhooks/': typeof AuthenticatedStoreIdSettingsWebhooksIndexRoute'/_authenticated/$storeId/products/price-lists/$priceListId/': typeof AuthenticatedStoreIdProductsPriceListsPriceListIdIndexRoute}export interface FileRouteTypes {@@ -416,7 +437,9 @@ export interface FileRouteTypes {| '/$storeId/promotions/'| '/$storeId/settings/'| '/$storeId/products/price-lists/new'+ | '/$storeId/settings/webhooks/$webhookEndpointId'| '/$storeId/products/price-lists/'+ | '/$storeId/settings/webhooks/'| '/$storeId/products/price-lists/$priceListId/'fileRoutesByTo: FileRoutesByToto:@@ -452,7 +475,9 @@ export interface FileRouteTypes {| '/$storeId/promotions'| '/$storeId/settings'| '/$storeId/products/price-lists/new'+ | '/$storeId/settings/webhooks/$webhookEndpointId'| '/$storeId/products/price-lists'+ | '/$storeId/settings/webhooks'| '/$storeId/products/price-lists/$priceListId'id:| '__root__'@@ -491,7 +516,9 @@ export interface FileRouteTypes {| '/_authenticated/$storeId/promotions/'| '/_authenticated/$storeId/settings/'| '/_authenticated/$storeId/products/price-lists/new'+ | '/_authenticated/$storeId/settings/webhooks/$webhookEndpointId'| '/_authenticated/$storeId/products/price-lists/'+ | '/_authenticated/$storeId/settings/webhooks/'| '/_authenticated/$storeId/products/price-lists/$priceListId/'fileRoutesById: FileRoutesById}@@ -741,6 +768,13 @@ declare module '@tanstack/react-router' {preLoaderRoute: typeof AuthenticatedStoreIdCustomersCustomerIdRouteImportparentRoute: typeof AuthenticatedStoreIdRoute}+ '/_authenticated/$storeId/settings/webhooks/': {+ id: '/_authenticated/$storeId/settings/webhooks/'+ path: '/webhooks'+ fullPath: '/$storeId/settings/webhooks/'+ preLoaderRoute: typeof AuthenticatedStoreIdSettingsWebhooksIndexRouteImport+ parentRoute: typeof AuthenticatedStoreIdSettingsRoute+ }'/_authenticated/$storeId/products/price-lists/': {id: '/_authenticated/$storeId/products/price-lists/'path: '/products/price-lists'@@ -748,6 +782,13 @@ declare module '@tanstack/react-router' {preLoaderRoute: typeof AuthenticatedStoreIdProductsPriceListsIndexRouteImportparentRoute: typeof AuthenticatedStoreIdRoute}+ '/_authenticated/$storeId/settings/webhooks/$webhookEndpointId': {+ id: '/_authenticated/$storeId/settings/webhooks/$webhookEndpointId'+ path: '/webhooks/$webhookEndpointId'+ fullPath: '/$storeId/settings/webhooks/$webhookEndpointId'+ preLoaderRoute: typeof AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRouteImport+ parentRoute: typeof AuthenticatedStoreIdSettingsRoute+ }'/_authenticated/$storeId/products/price-lists/new': {id: '/_authenticated/$storeId/products/price-lists/new'path: '/products/price-lists/new'@@ -777,6 +818,8 @@ interface AuthenticatedStoreIdSettingsRouteChildren {AuthenticatedStoreIdSettingsStoreRoute: typeof AuthenticatedStoreIdSettingsStoreRouteAuthenticatedStoreIdSettingsTaxCategoriesRoute: typeof AuthenticatedStoreIdSettingsTaxCategoriesRouteAuthenticatedStoreIdSettingsIndexRoute: typeof AuthenticatedStoreIdSettingsIndexRoute+ AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute: typeof AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute+ AuthenticatedStoreIdSettingsWebhooksIndexRoute: typeof AuthenticatedStoreIdSettingsWebhooksIndexRoute}const AuthenticatedStoreIdSettingsRouteChildren: AuthenticatedStoreIdSettingsRouteChildren =@@ -803,6 +846,10 @@ const AuthenticatedStoreIdSettingsRouteChildren: AuthenticatedStoreIdSettingsRouAuthenticatedStoreIdSettingsTaxCategoriesRoute,AuthenticatedStoreIdSettingsIndexRoute:AuthenticatedStoreIdSettingsIndexRoute,+ AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute:+ AuthenticatedStoreIdSettingsWebhooksWebhookEndpointIdRoute,+ AuthenticatedStoreIdSettingsWebhooksIndexRoute:+ AuthenticatedStoreIdSettingsWebhooksIndexRoute,}const AuthenticatedStoreIdSettingsRouteWithChildren =diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/webhooks/$webhookEndpointId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/webhooks/$webhookEndpointId.tsxnew file mode 100644index 0000000000..e29d91939c--- /dev/null+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/webhooks/$webhookEndpointId.tsx@@ -0,0 +1,754 @@+import { zodResolver } from '@hookform/resolvers/zod'+import type {+ WebhookDelivery,+ WebhookEndpoint,+ WebhookEndpointUpdateParams,+} from '@spree/admin-sdk'+import {+ adminClient,+ Can,+ mapSpreeErrorsToForm,+ PageHeader,+ type ResourceSearch,+ ResourceTable,+ resourceSearchSchema,+ Subject,+} from '@spree/dashboard-core'+import {+ Badge,+ Button,+ Card,+ CardContent,+ CardHeader,+ CardTitle,+ CopyToClipboardButton,+ cn,+ ErrorState,+ RelativeTime,+ ResourceLayout,+ Sheet,+ SheetContent,+ SheetDescription,+ SheetFooter,+ SheetHeader,+ SheetTitle,+ Skeleton,+ useConfirm,+ useFormSubmitShortcut,+ useRowClickBridge,+} from '@spree/dashboard-ui'+import { createFileRoute, useNavigate } from '@tanstack/react-router'+import { AlertTriangleIcon, PencilIcon, PlayIcon, RotateCcwIcon } from 'lucide-react'+import { lazy, Suspense } from 'react'+import { type UseFormReturn, useForm } from 'react-hook-form'+import { useTranslation } from 'react-i18next'+import { toast } from 'sonner'+import { z } from 'zod/v4'+import { WebhookEndpointFormFields } from '@/components/spree/webhook-endpoint-form'+import {+ useDeleteWebhookEndpoint,+ useRedeliverWebhookDelivery,+ useSendTestWebhook,+ useToggleWebhookEndpoint,+ useUpdateWebhookEndpoint,+ useWebhookDelivery,+ useWebhookEndpoint,+} from '@/hooks/use-webhook-endpoints'+import { webhookEndpointHealth, webhookHealthBadgeVariant } from '@/lib/webhook-health'+import {+ DEFAULT_WEBHOOK_ENDPOINT_VALUES,+ type WebhookEndpointFormValues,+ webhookEndpointFormSchema,+} from '@/schemas/webhook-endpoint'+import '@/tables/webhook-deliveries'++// `<JsonValueView>` pulls in `@uiw/react-json-view` (~30 KB gzip). Lazy-loading+// it keeps the route's entry chunk small — the renderer only matters when an+// admin opens a delivery detail.+const JsonValueView = lazy(() =>+ import('@spree/dashboard-ui/spree/json-value-view').then((m) => ({ default: m.JsonValueView })),+)++// The route shares its URL with the embedded deliveries `<ResourceTable>` —+// `page`/`sort`/`filters`/`search` come from `resourceSearchSchema`; `delivery`+// is the prefixed ID of the row whose detail sheet is open; `edit=1` opens+// the edit sheet so deep-links and back navigation behave predictably.+const detailSearchSchema = resourceSearchSchema.extend({+ delivery: z.string().optional(),+ edit: z.coerce.boolean().optional(),+})++export const Route = createFileRoute(+ '/_authenticated/$storeId/settings/webhooks/$webhookEndpointId',+)({+ validateSearch: detailSearchSchema,+ component: WebhookEndpointDetailPage,+})++function WebhookEndpointDetailPage() {+ const { t } = useTranslation()+ const { webhookEndpointId } = Route.useParams()+ const { data: endpoint, isLoading, error, refetch } = useWebhookEndpoint(webhookEndpointId)++ if (isLoading) {+ return <p className="text-muted-foreground">{t('admin.common.loading')}</p>+ }+ if (error || !endpoint) {+ return (+ <ErrorState+ title={t('admin.pages.settings.webhooks.detail.load_failed_title')}+ description={error instanceof Error ? error.message : undefined}+ onRetry={() => refetch()}+ />+ )+ }+ return <WebhookEndpointDetailBody endpoint={endpoint} />+}++function WebhookEndpointDetailBody({ endpoint }: { endpoint: WebhookEndpoint }) {+ const { t } = useTranslation()+ const { storeId, webhookEndpointId } = Route.useParams()+ const search = Route.useSearch() as z.infer<typeof detailSearchSchema>+ const navigate = useNavigate()+ const confirm = useConfirm()++ const updateMutation = useUpdateWebhookEndpoint(webhookEndpointId)+ const deleteMutation = useDeleteWebhookEndpoint()+ const toggleMutation = useToggleWebhookEndpoint()+ const sendTestMutation = useSendTestWebhook()++ // ---- Form (Edit card) -------------------------------------------------+ const form = useForm<WebhookEndpointFormValues>({+ resolver: zodResolver(webhookEndpointFormSchema),+ defaultValues: DEFAULT_WEBHOOK_ENDPOINT_VALUES,+ // `keepDirtyValues` so a background refetch doesn't wipe user edits.+ values: {+ name: endpoint.name,+ url: endpoint.url,+ active: endpoint.active,+ subscriptions: endpoint.subscriptions ?? [],+ },+ resetOptions: { keepDirtyValues: true },+ })++ async function onSubmit(values: WebhookEndpointFormValues) {+ try {+ await updateMutation.mutateAsync({+ name: values.name?.trim() || null,+ url: values.url,+ active: values.active,+ subscriptions: values.subscriptions,+ } satisfies WebhookEndpointUpdateParams)+ form.reset(values)+ } catch (err) {+ if (!mapSpreeErrorsToForm(err, form.setError)) throw err+ }+ }++ useFormSubmitShortcut(form, onSubmit)++ // ---- Header actions ---------------------------------------------------+ async function handleDelete() {+ const ok = await confirm({+ title: t('admin.pages.settings.webhooks.delete_confirm.title'),+ message: t('admin.pages.settings.webhooks.delete_confirm.message', {+ name: endpoint.name || endpoint.url,+ }),+ variant: 'destructive',+ confirmLabel: t('admin.actions.delete'),+ })+ if (!ok) return+ await deleteMutation.mutateAsync(endpoint.id)+ navigate({ to: '/$storeId/settings/webhooks', params: { storeId } })+ }++ async function handleSendTest() {+ try {+ await sendTestMutation.mutateAsync(endpoint.id)+ toast.success(t('admin.pages.settings.webhooks.deliveries.test_sent'))+ } catch (err) {+ toast.error(+ err instanceof Error+ ? err.message+ : t('admin.pages.settings.webhooks.deliveries.test_failed'),+ )+ }+ }++ function handleReEnable() {+ toggleMutation.mutateAsync({ id: endpoint.id, active: true }).catch(() => undefined)+ }++ // ---- Sheet state -------------------------------------------------------+ // Sheet toggles use `replace: true` so opening/closing doesn't add history+ // entries — otherwise the page's back arrow (which calls+ // `router.history.back()`) would step back into the just-closed sheet+ // instead of leaving the page.+ const detailDeliveryId = search.delivery+ const editOpen = !!search.edit+ const openDelivery = (id: string) =>+ navigate({+ search: (prev: Record<string, unknown>) => ({ ...prev, delivery: id }) as never,+ replace: true,+ })+ const closeDelivery = () =>+ navigate({+ search: (prev: Record<string, unknown>) => {+ const { delivery: _d, ...rest } = prev+ return rest as never+ },+ replace: true,+ })+ const openEdit = () =>+ navigate({+ search: (prev: Record<string, unknown>) => ({ ...prev, edit: true }) as never,+ replace: true,+ })+ const closeEdit = () => {+ // Drop any unsaved edits when the sheet closes — the values prop on+ // useForm will re-seed from the latest endpoint on the next open.+ form.reset()+ navigate({+ search: (prev: Record<string, unknown>) => {+ const { edit: _e, ...rest } = prev+ return rest as never+ },+ replace: true,+ })+ }++ return (+ <>+ <ResourceLayout+ header={+ <PageHeader+ title={endpoint.name || endpoint.url}+ subtitle={endpoint.name ? <CopyableUrl url={endpoint.url} /> : undefined}+ backTo="settings/webhooks"+ resource={{ id: endpoint.id }}+ onDelete={handleDelete}+ deleteLabel={t('admin.pages.settings.webhooks.detail.delete_label')}+ actions={+ <Can I="update" a={Subject.WebhookEndpoint}>+ <Button+ size="sm"+ variant="outline"+ onClick={handleSendTest}+ disabled={sendTestMutation.isPending || !!endpoint.disabled_at}+ >+ <PlayIcon className="size-4" />+ {t('admin.pages.settings.webhooks.actions.send_test')}+ </Button>+ <Button size="sm" variant="outline" onClick={openEdit}>+ <PencilIcon className="size-4" />+ {t('admin.actions.edit')}+ </Button>+ </Can>+ }+ />+ }+ main={+ <>+ {endpoint.disabled_at && (+ <AutoDisabledAlert+ endpoint={endpoint}+ onReEnable={handleReEnable}+ reEnabling={toggleMutation.isPending}+ />+ )}+ <HealthSummaryCard endpoint={endpoint} />+ <DeliveriesCard+ endpointId={endpoint.id}+ onSelect={openDelivery}+ searchParams={search}+ />+ </>+ }+ sidebar={<DetailsCard endpoint={endpoint} />}+ />+ <EditEndpointSheet+ endpoint={endpoint}+ form={form}+ open={editOpen}+ onOpenChange={(o) => (o ? openEdit() : closeEdit())}+ onSubmit={async (values) => {+ await onSubmit(values)+ closeEdit()+ }}+ />+ {detailDeliveryId && (+ <DeliveryDetailSheet+ endpointId={endpoint.id}+ deliveryId={detailDeliveryId}+ open+ onOpenChange={(o) => !o && closeDelivery()}+ />+ )}+ </>+ )+}++// ---------------------------------------------------------------------------+// Auto-disabled banner — matches the alert at the top of the legacy show view.+// ---------------------------------------------------------------------------++function AutoDisabledAlert({+ endpoint,+ onReEnable,+ reEnabling,+}: {+ endpoint: WebhookEndpoint+ onReEnable: () => void+ reEnabling: boolean+}) {+ const { t } = useTranslation()+ return (+ <div className="flex flex-col gap-2 rounded-md border border-destructive/40 bg-destructive/5 p-3 text-sm text-destructive sm:flex-row sm:items-center sm:justify-between">+ <span className="flex items-start gap-2">+ <AlertTriangleIcon className="size-4 shrink-0" />+ {endpoint.disabled_reason || t('admin.pages.settings.webhooks.health.auto_disabled_alert')}+ </span>+ <Button type="button" size="sm" variant="outline" onClick={onReEnable} disabled={reEnabling}>+ {t('admin.pages.settings.webhooks.health.re_enable_cta')}+ </Button>+ </div>+ )+}++// ---------------------------------------------------------------------------+// 4-tile health summary — Health badge / Deliveries / Successful / Failed.+// Mirrors `spree/admin/app/views/spree/admin/webhook_endpoints/_summary.html.erb`.+// ---------------------------------------------------------------------------++function HealthSummaryCard({ endpoint }: { endpoint: WebhookEndpoint }) {+ const { t } = useTranslation()++ const bucket = webhookEndpointHealth(endpoint)+ const variant = webhookHealthBadgeVariant(bucket)++ let healthLabel: string+ switch (bucket.kind) {+ case 'disabled':+ healthLabel = t('admin.pages.settings.webhooks.health.disabled')+ break+ case 'no_deliveries':+ healthLabel = t('admin.pages.settings.webhooks.health.no_deliveries')+ break+ case 'healthy':+ healthLabel = t('admin.pages.settings.webhooks.health.healthy', {+ percentage: bucket.percentage,+ })+ break+ case 'degraded':+ healthLabel = t('admin.pages.settings.webhooks.health.degraded', {+ percentage: bucket.percentage,+ })+ break+ case 'failing':+ healthLabel = t('admin.pages.settings.webhooks.health.failing', {+ percentage: bucket.percentage,+ })+ break+ }++ const total = endpoint.total_delivery_count ?? 0+ const successful = endpoint.successful_delivery_count ?? 0+ const failed = endpoint.failed_delivery_count ?? 0++ return (+ <Card>+ <CardContent>+ <div className="grid grid-cols-2 gap-6 sm:grid-cols-4">+ <HealthStat label={t('admin.pages.settings.webhooks.health.label')}>+ <Badge variant={variant}>{healthLabel}</Badge>+ </HealthStat>+ <HealthStat label={t('admin.pages.settings.webhooks.health.metric_total')}>+ <span className="text-lg font-semibold">{total}</span>+ </HealthStat>+ <HealthStat label={t('admin.pages.settings.webhooks.health.metric_successful')}>+ <span className="text-lg font-semibold">{successful}</span>+ </HealthStat>+ <HealthStat label={t('admin.pages.settings.webhooks.health.metric_failed')}>+ <span className={cn('text-lg font-semibold', failed > 0 && 'text-destructive')}>+ {failed}+ </span>+ </HealthStat>+ </div>+ </CardContent>+ </Card>+ )+}++function HealthStat({ label, children }: { label: string; children: React.ReactNode }) {+ return (+ <div className="flex flex-col gap-1.5">+ <span className="text-xs uppercase tracking-wide text-muted-foreground">{label}</span>+ {children}+ </div>+ )+}++// ---------------------------------------------------------------------------+// Embedded deliveries list — the page's main content. Uses ResourceTable so+// pagination, sorting, and filters all flow through the URL.+// ---------------------------------------------------------------------------++function DeliveriesCard({+ endpointId,+ onSelect,+ searchParams,+}: {+ endpointId: string+ onSelect: (deliveryId: string) => void+ searchParams: ResourceSearch+}) {+ // The deliveries table's event-name cell carries `data-webhook-delivery-id`.+ // Bridging at the page level (rather than on the row) keeps cell rendering+ // identifier-free and survives ResourceTable's virtualisation/pagination.+ useRowClickBridge('data-webhook-delivery-id', onSelect)++ return (+ <ResourceTable<WebhookDelivery>+ tableKey="webhook-deliveries"+ // Scope the cache to the parent endpoint so two endpoints' deliveries+ // can't collide in TanStack Query.+ queryKey={`webhook-deliveries:${endpointId}`}+ queryFn={(params) => adminClient.webhookEndpoints.deliveries.list(endpointId, params)}+ searchParams={searchParams}+ />+ )+}++// ---------------------------------------------------------------------------+// Right-column "Details" card. Mirrors `_details.html.erb`.+// ---------------------------------------------------------------------------++// Copyable URL rendered as the page subtitle — the destination URL is the+// most useful identifier after the name and used to live in a Details row+// where it overflowed. Inlining it next to the title removes the redundancy.+function CopyableUrl({ url }: { url: string }) {+ const { t } = useTranslation()+ return (+ <span className="inline-flex max-w-full items-center gap-1.5">+ <span className="truncate font-mono">{url}</span>+ <CopyToClipboardButton+ value={url}+ aria-label={t('admin.pages.settings.webhooks.table.copy_url_aria')}+ />+ </span>+ )+}++function DetailsCard({ endpoint }: { endpoint: WebhookEndpoint }) {+ const { t } = useTranslation()++ return (+ <Card>+ <CardHeader>+ <CardTitle>{t('admin.pages.settings.webhooks.detail.details_title')}</CardTitle>+ </CardHeader>+ <CardContent className="flex flex-col divide-y divide-border p-0">+ <DetailRow+ label={t('admin.pages.settings.webhooks.detail.subscriptions')}+ value={+ endpoint.subscriptions && endpoint.subscriptions.length > 0 ? (+ <div className="flex max-w-[16rem] flex-wrap justify-end gap-1">+ {endpoint.subscriptions.map((s) => (+ <Badge key={s} variant="secondary" className="font-mono text-[10px]">+ {s}+ </Badge>+ ))}+ </div>+ ) : (+ <Badge variant="secondary">{t('admin.pages.settings.webhooks.events_all')}</Badge>+ )+ }+ />+ <DetailRow+ label={t('admin.pages.settings.webhooks.detail.created_at')}+ value={<RelativeTime iso={endpoint.created_at} />}+ />+ <DetailRow+ label={t('admin.pages.settings.webhooks.detail.updated_at')}+ value={<RelativeTime iso={endpoint.updated_at} />}+ />+ </CardContent>+ </Card>+ )+}++// ---------------------------------------------------------------------------+// Edit endpoint sheet — opens via the header "Edit" button and the `?edit=1`+// URL param. Renders the same form fields as the Create flow.+// ---------------------------------------------------------------------------++function EditEndpointSheet({+ endpoint,+ form,+ open,+ onOpenChange,+ onSubmit,+}: {+ endpoint: WebhookEndpoint+ form: UseFormReturn<WebhookEndpointFormValues>+ open: boolean+ onOpenChange: (open: boolean) => void+ onSubmit: (values: WebhookEndpointFormValues) => Promise<void> | void+}) {+ const { t } = useTranslation()++ return (+ <Sheet open={open} onOpenChange={onOpenChange}>+ <SheetContent className="sm:max-w-xl">+ <SheetHeader>+ <SheetTitle>+ {endpoint.name || endpoint.url || t('admin.pages.settings.webhooks.edit_sheet_title')}+ </SheetTitle>+ {endpoint.disabled_at && endpoint.disabled_reason && (+ <SheetDescription className="text-destructive">+ {t('admin.pages.settings.webhooks.status.disabled_reason', {+ reason: endpoint.disabled_reason,+ })}+ </SheetDescription>+ )}+ </SheetHeader>+ <form onSubmit={form.handleSubmit(onSubmit)} className="flex min-h-0 flex-1 flex-col">+ <div className="flex flex-1 flex-col gap-4 overflow-y-auto p-4">+ <WebhookEndpointFormFields form={form} />+ </div>+ <SheetFooter>+ <Button+ type="button"+ variant="outline"+ size="sm"+ onClick={() => onOpenChange(false)}+ disabled={form.formState.isSubmitting}+ >+ {t('admin.actions.cancel')}+ </Button>+ <Button+ type="submit"+ size="sm"+ disabled={form.formState.isSubmitting || !form.formState.isDirty}+ >+ {form.formState.isSubmitting ? t('admin.actions.saving') : t('admin.actions.save')}+ </Button>+ </SheetFooter>+ </form>+ </SheetContent>+ </Sheet>+ )+}++// ---------------------------------------------------------------------------+// Delivery detail sheet — mirrors the legacy admin's webhook_deliveries#show+// view (event, status, URL, code/time/error, request payload, response body,+// redeliver CTA on failures).+// ---------------------------------------------------------------------------++// Cap the response body at 2000 characters (matches the legacy view) so a+// misconfigured endpoint returning a multi-MB HTML error page doesn't blow+// up the sheet.+const RESPONSE_BODY_LIMIT = 2000++function DeliveryDetailSheet({+ endpointId,+ deliveryId,+ open,+ onOpenChange,+}: {+ endpointId: string+ deliveryId: string+ open: boolean+ onOpenChange: (open: boolean) => void+}) {+ const { t } = useTranslation()+ const { data: delivery, isLoading } = useWebhookDelivery(endpointId, deliveryId)+ const redeliver = useRedeliverWebhookDelivery(endpointId)++ const statusKey = delivery ? deliveryStatusKey(delivery) : null+ const failed = statusKey === 'failure' || statusKey === 'error'+ const truncatedResponse =+ delivery?.response_body && delivery.response_body.length > RESPONSE_BODY_LIMIT+ ? delivery.response_body.slice(0, RESPONSE_BODY_LIMIT)+ : (delivery?.response_body ?? '')++ return (+ <Sheet open={open} onOpenChange={onOpenChange}>+ <SheetContent className="sm:max-w-2xl">+ <SheetHeader>+ <SheetTitle>+ {t('admin.pages.settings.webhooks.deliveries.detail_sheet_title')}+ </SheetTitle>+ </SheetHeader>+ <div className="flex min-h-0 flex-1 flex-col gap-4 overflow-y-auto p-4">+ {isLoading || !delivery ? (+ <Skeleton className="h-40 w-full" />+ ) : (+ <>+ <Card>+ <CardContent className="p-0">+ <dl className="divide-y divide-border">+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.event')}+ value={<code className="font-mono text-xs">{delivery.event_name}</code>}+ />+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.status')}+ value={+ <Badge+ variant={+ statusKey === 'success'+ ? 'default'+ : failed+ ? 'destructive'+ : 'secondary'+ }+ >+ {t(`admin.pages.settings.webhooks.deliveries.status.${statusKey}`)}+ </Badge>+ }+ />+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.url')}+ value={+ <a+ href={delivery.webhook_endpoint_url}+ target="_blank"+ rel="noopener noreferrer"+ className="font-mono text-xs break-all text-foreground underline-offset-2 hover:underline"+ >+ {delivery.webhook_endpoint_url}+ </a>+ }+ />+ {delivery.delivered_at && (+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.delivered_at')}+ value={<RelativeTime iso={delivery.delivered_at} />}+ />+ )}+ {delivery.response_code != null && (+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.response_code')}+ value={<code className="font-mono text-xs">{delivery.response_code}</code>}+ />+ )}+ {delivery.execution_time != null && (+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.execution_time')}+ value={+ <code className="font-mono text-xs">{delivery.execution_time}ms</code>+ }+ />+ )}+ {delivery.error_type && (+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.error_type')}+ value={<code className="font-mono text-xs">{delivery.error_type}</code>}+ />+ )}+ {delivery.request_errors && (+ <DetailRow+ label={t('admin.pages.settings.webhooks.deliveries.detail.request_errors')}+ value={+ <code className="font-mono text-xs break-all whitespace-pre-wrap">+ {delivery.request_errors}+ </code>+ }+ />+ )}+ </dl>+ </CardContent>+ </Card>++ <Card>+ <CardHeader className="flex flex-row items-center justify-between">+ <CardTitle className="text-sm">+ {t('admin.pages.settings.webhooks.deliveries.detail.request_payload')}+ </CardTitle>+ <CopyToClipboardButton+ value={JSON.stringify(delivery.payload ?? {}, null, 2)}+ aria-label={t(+ 'admin.pages.settings.webhooks.deliveries.detail.copy_payload_aria',+ )}+ />+ </CardHeader>+ <CardContent>+ <Suspense fallback={<Skeleton className="h-40 w-full rounded-md" />}>+ <JsonValueView value={delivery.payload ?? {}} />+ </Suspense>+ </CardContent>+ </Card>++ {delivery.response_body && (+ <Card>+ <CardHeader className="flex flex-row items-center justify-between">+ <CardTitle className="text-sm">+ {t('admin.pages.settings.webhooks.deliveries.detail.response_body')}+ </CardTitle>+ <CopyToClipboardButton+ value={delivery.response_body}+ aria-label={t(+ 'admin.pages.settings.webhooks.deliveries.detail.copy_response_aria',+ )}+ />+ </CardHeader>+ <CardContent className="flex flex-col gap-2">+ <pre className="overflow-x-auto rounded-md border border-border bg-muted/40 p-3 font-mono text-xs break-all whitespace-pre-wrap">+ {truncatedResponse}+ </pre>+ {delivery.response_body.length > RESPONSE_BODY_LIMIT && (+ <span className="text-xs text-muted-foreground">+ {t(+ 'admin.pages.settings.webhooks.deliveries.detail.response_body_truncated',+ { limit: RESPONSE_BODY_LIMIT },+ )}+ </span>+ )}+ </CardContent>+ </Card>+ )}+ </>+ )}+ </div>+ {failed && (+ <SheetFooter>+ <Button+ type="button"+ size="sm"+ onClick={() =>+ redeliver+ .mutateAsync(deliveryId)+ .then(() =>+ toast.success(t('admin.pages.settings.webhooks.deliveries.redeliver_queued')),+ )+ .catch(() => undefined)+ }+ disabled={redeliver.isPending}+ >+ <RotateCcwIcon className="size-4" />+ {t('admin.pages.settings.webhooks.actions.redeliver')}+ </Button>+ </SheetFooter>+ )}+ </SheetContent>+ </Sheet>+ )+}++function DetailRow({ label, value }: { label: string; value: React.ReactNode }) {+ return (+ <div className="flex flex-row items-start justify-between gap-4 px-4 py-3">+ <dt className="text-sm text-muted-foreground">{label}</dt>+ <dd className="max-w-full text-right text-sm">{value}</dd>+ </div>+ )+}++function deliveryStatusKey(d: WebhookDelivery): 'pending' | 'success' | 'failure' | 'error' {+ if (d.delivered_at == null) return 'pending'+ if (d.success === true) return 'success'+ if (d.error_type) return 'error'+ return 'failure'+}diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/webhooks/index.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/webhooks/index.tsxnew file mode 100644index 0000000000..3389507937--- /dev/null+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/webhooks/index.tsx@@ -0,0 +1,337 @@+import { zodResolver } from '@hookform/resolvers/zod'+import type { WebhookEndpoint, WebhookEndpointCreateParams } from '@spree/admin-sdk'+import {+ adminClient,+ Can,+ mapSpreeErrorsToForm,+ ResourceTable,+ resourceSearchSchema,+ Subject,+ usePermissions,+} from '@spree/dashboard-core'+import {+ Button,+ Dialog,+ DialogBody,+ DialogContent,+ DialogDescription,+ DialogFooter,+ DialogHeader,+ DialogTitle,+ RowActions,+ Sheet,+ SheetContent,+ SheetDescription,+ SheetFooter,+ SheetHeader,+ SheetTitle,+ useConfirm,+ useCopyToClipboard,+ useRowClickBridge,+} from '@spree/dashboard-ui'+import { createFileRoute, useNavigate } from '@tanstack/react-router'+import { AlertTriangleIcon, BanIcon, CheckIcon, CopyIcon, PlayIcon, PlusIcon } from 'lucide-react'+import { useState } from 'react'+import { useForm } from 'react-hook-form'+import { useTranslation } from 'react-i18next'+import { toast } from 'sonner'+import { z } from 'zod/v4'+import { WebhookEndpointFormFields } from '@/components/spree/webhook-endpoint-form'+import {+ useCreateWebhookEndpoint,+ useDeleteWebhookEndpoint,+ useSendTestWebhook,+ useToggleWebhookEndpoint,+} from '@/hooks/use-webhook-endpoints'+import {+ DEFAULT_WEBHOOK_ENDPOINT_VALUES,+ type WebhookEndpointFormValues,+ webhookEndpointFormSchema,+} from '@/schemas/webhook-endpoint'+import '@/tables/webhook-endpoints'++const webhooksSearchSchema = resourceSearchSchema.extend({+ new: z.coerce.boolean().optional(),+})++export const Route = createFileRoute('/_authenticated/$storeId/settings/webhooks/')({+ validateSearch: webhooksSearchSchema,+ component: WebhooksPage,+})++function WebhooksPage() {+ const { t } = useTranslation()+ const { storeId } = Route.useParams()+ const search = Route.useSearch() as z.infer<typeof webhooksSearchSchema>+ const navigate = useNavigate()+ const confirm = useConfirm()+ const deleteMutation = useDeleteWebhookEndpoint()+ const toggleMutation = useToggleWebhookEndpoint()+ const sendTestMutation = useSendTestWebhook()+ const { permissions } = usePermissions()++ // The Create flow ends with a one-shot secret reveal — only `create`+ // returns `secret_key`, so we have to surface it before navigating away.+ const [secretReveal, setSecretReveal] = useState<WebhookEndpoint | null>(null)++ const isCreating = !!search.new++ const closeCreate = () =>+ navigate({+ search: (prev: Record<string, unknown>) => {+ const { new: _n, ...rest } = prev+ return rest as never+ },+ })++ const openCreate = () =>+ navigate({ search: (prev: Record<string, unknown>) => ({ ...prev, new: true }) as never })++ // Row click opens the dedicated detail page rather than a sheet — that page+ // owns the deliveries list, health summary, and edit form.+ useRowClickBridge('data-webhook-endpoint-id', (id: string) =>+ navigate({+ to: '/$storeId/settings/webhooks/$webhookEndpointId',+ params: { storeId, webhookEndpointId: id },+ }),+ )++ async function handleDelete(endpoint: WebhookEndpoint) {+ const ok = await confirm({+ title: t('admin.pages.settings.webhooks.delete_confirm.title'),+ message: t('admin.pages.settings.webhooks.delete_confirm.message', {+ name: endpoint.name || endpoint.url,+ }),+ variant: 'destructive',+ confirmLabel: t('admin.actions.delete'),+ })+ if (!ok) return+ await deleteMutation.mutateAsync(endpoint.id).catch(() => undefined)+ }++ async function handleSendTest(endpoint: WebhookEndpoint) {+ try {+ await sendTestMutation.mutateAsync(endpoint.id)+ toast.success(t('admin.pages.settings.webhooks.deliveries.test_sent'))+ } catch (err) {+ toast.error(+ err instanceof Error+ ? err.message+ : t('admin.pages.settings.webhooks.deliveries.test_failed'),+ )+ }+ }++ return (+ <>+ <ResourceTable<WebhookEndpoint>+ tableKey="webhook-endpoints"+ queryKey="webhook-endpoints"+ queryFn={(params) => adminClient.webhookEndpoints.list(params)}+ searchParams={search}+ rowActions={(endpoint) => (+ <RowActions+ actions={[+ {+ key: 'edit',+ label: t('admin.actions.edit'),+ onSelect: () =>+ navigate({+ to: '/$storeId/settings/webhooks/$webhookEndpointId',+ params: { storeId, webhookEndpointId: endpoint.id },+ // Land directly on the detail page with the Edit sheet open.+ search: { edit: true } as never,+ }),+ },+ {+ key: 'send_test',+ label: t('admin.pages.settings.webhooks.actions.send_test'),+ icon: <PlayIcon className="size-4" />,+ disabled: sendTestMutation.isPending || !!endpoint.disabled_at,+ onSelect: () => handleSendTest(endpoint),+ },+ {+ key: 'toggle',+ label: endpoint.active+ ? t('admin.pages.settings.webhooks.actions.disable')+ : t('admin.pages.settings.webhooks.actions.enable'),+ icon: <BanIcon className="size-4" />,+ disabled: toggleMutation.isPending,+ onSelect: () =>+ toggleMutation+ .mutateAsync({ id: endpoint.id, active: !endpoint.active })+ .catch(() => undefined),+ },+ {+ key: 'delete',+ destructive: true,+ visible: permissions.can('destroy', Subject.WebhookEndpoint),+ disabled: deleteMutation.isPending,+ onSelect: () => handleDelete(endpoint),+ },+ ]}+ />+ )}+ actions={+ <Can I="create" a={Subject.WebhookEndpoint}>+ <Button size="sm" className="h-[2.125rem]" onClick={openCreate}>+ <PlusIcon className="size-4" />+ {t('admin.pages.settings.webhooks.new_cta')}+ </Button>+ </Can>+ }+ />++ {isCreating && (+ <CreateEndpointSheet+ open+ onOpenChange={(o) => !o && closeCreate()}+ onCreated={(endpoint) => {+ closeCreate()+ if (endpoint.secret_key) setSecretReveal(endpoint)+ }}+ />+ )}++ <SecretRevealDialog+ endpoint={secretReveal}+ onOpenChange={(open) => {+ if (!open && secretReveal) {+ const id = secretReveal.id+ setSecretReveal(null)+ // Drop the admin straight onto the new endpoint's detail page —+ // they probably want to verify the subscription list, send a+ // test, etc.+ navigate({+ to: '/$storeId/settings/webhooks/$webhookEndpointId',+ params: { storeId, webhookEndpointId: id },+ })+ }+ }}+ />+ </>+ )+}++// ---------------------------------------------------------------------------+// Create sheet+// ---------------------------------------------------------------------------++function CreateEndpointSheet({+ open,+ onOpenChange,+ onCreated,+}: {+ open: boolean+ onOpenChange: (open: boolean) => void+ onCreated: (endpoint: WebhookEndpoint) => void+}) {+ const { t } = useTranslation()+ const createMutation = useCreateWebhookEndpoint()+ const form = useForm<WebhookEndpointFormValues>({+ resolver: zodResolver(webhookEndpointFormSchema),+ defaultValues: DEFAULT_WEBHOOK_ENDPOINT_VALUES,+ })++ async function onSubmit(values: WebhookEndpointFormValues) {+ const params: WebhookEndpointCreateParams = {+ name: values.name?.trim() || null,+ url: values.url,+ active: values.active,+ subscriptions: values.subscriptions,+ }+ try {+ const endpoint = await createMutation.mutateAsync(params)+ form.reset(DEFAULT_WEBHOOK_ENDPOINT_VALUES)+ onCreated(endpoint)+ } catch (err) {+ if (!mapSpreeErrorsToForm(err, form.setError)) throw err+ }+ }++ return (+ <Sheet+ open={open}+ onOpenChange={(next) => {+ if (!next) form.reset(DEFAULT_WEBHOOK_ENDPOINT_VALUES)+ onOpenChange(next)+ }}+ >+ <SheetContent className="sm:max-w-xl">+ <SheetHeader>+ <SheetTitle>{t('admin.pages.settings.webhooks.add_sheet_title')}</SheetTitle>+ <SheetDescription>{t('admin.pages.settings.webhooks.subtitle')}</SheetDescription>+ </SheetHeader>+ <form onSubmit={form.handleSubmit(onSubmit)} className="flex min-h-0 flex-1 flex-col">+ <div className="flex flex-1 flex-col gap-4 overflow-y-auto p-4">+ <WebhookEndpointFormFields form={form} />+ </div>+ <SheetFooter>+ <Button+ type="button"+ variant="outline"+ size="sm"+ onClick={() => onOpenChange(false)}+ disabled={form.formState.isSubmitting}+ >+ {t('admin.actions.cancel')}+ </Button>+ <Button type="submit" size="sm" disabled={form.formState.isSubmitting}>+ {form.formState.isSubmitting+ ? t('admin.actions.creating')+ : t('admin.actions.create')}+ </Button>+ </SheetFooter>+ </form>+ </SheetContent>+ </Sheet>+ )+}++// ---------------------------------------------------------------------------+// Secret reveal dialog — one-shot, immediately after create.+// ---------------------------------------------------------------------------++function SecretRevealDialog({+ endpoint,+ onOpenChange,+}: {+ endpoint: WebhookEndpoint | null+ onOpenChange: (open: boolean) => void+}) {+ const { t } = useTranslation()+ const { copied, copy } = useCopyToClipboard()++ return (+ <Dialog open={!!endpoint} onOpenChange={onOpenChange}>+ <DialogContent>+ <DialogHeader>+ <DialogTitle>{t('admin.pages.settings.webhooks.save_secret_title')}</DialogTitle>+ <DialogDescription>+ {t('admin.pages.settings.webhooks.save_secret_description')}+ </DialogDescription>+ </DialogHeader>+ <DialogBody className="flex flex-col gap-3">+ <div className="flex items-start gap-2 rounded-md border border-yellow-200 bg-yellow-50 p-3 text-sm text-yellow-900 dark:border-yellow-900/40 dark:bg-yellow-950/40 dark:text-yellow-200">+ <AlertTriangleIcon className="size-4 shrink-0" />+ <span>{t('admin.api_keys.warning_treat_like_password')}</span>+ </div>+ {endpoint?.secret_key && (+ <div className="flex items-center gap-2 rounded-md border border-border bg-muted/40 p-3">+ <code className="flex-1 truncate font-mono text-sm">{endpoint.secret_key}</code>+ <Button size="sm" variant="outline" onClick={() => copy(endpoint.secret_key ?? '')}>+ {copied ? <CheckIcon /> : <CopyIcon />}+ {copied ? t('admin.actions.copied') : t('admin.actions.copy')}+ </Button>+ </div>+ )}+ </DialogBody>+ <DialogFooter>+ <Button size="sm" onClick={() => onOpenChange(false)}>+ {t('admin.actions.done')}+ </Button>+ </DialogFooter>+ </DialogContent>+ </Dialog>+ )+}diff --git a/packages/dashboard/src/schemas/webhook-endpoint.ts b/packages/dashboard/src/schemas/webhook-endpoint.tsnew file mode 100644index 0000000000..f17a8c8dae--- /dev/null+++ b/packages/dashboard/src/schemas/webhook-endpoint.ts@@ -0,0 +1,249 @@+import { requiredMessage } from '@spree/dashboard-ui'+import { z } from 'zod/v4'++export const webhookEndpointFormSchema = z.object({+ name: z.string().trim().optional().nullable(),+ url: z+ .string()+ .min(1, { error: requiredMessage('webhook_endpoint.url') })+ .url(),+ active: z.boolean(),+ // Empty array == subscribe to every event (the model treats `[]` and `['*']`+ // the same). The picker emits an empty array when nothing is selected.+ subscriptions: z.array(z.string().min(1)),+})++export type WebhookEndpointFormValues = z.infer<typeof webhookEndpointFormSchema>++export const DEFAULT_WEBHOOK_ENDPOINT_VALUES: WebhookEndpointFormValues = {+ name: '',+ url: '',+ active: true,+ subscriptions: [],+}++/**+ * Catalog of built-in events Spree core publishes. Sourced from+ * `publish_event` call sites plus the `publishes_lifecycle_events` concern+ * (which auto-fires `<model_name>.created/updated/deleted`).+ *+ * Plugin-published events are not enumerated here — the form's free-text+ * input lets admins type any event name (e.g. `loyalty.points_earned`) so+ * plugins don't need to register UI hints to be subscribable.+ *+ * `labelKey` is an i18n key under `admin.pages.settings.webhooks.event_groups`+ * — consumers resolve it via `t(labelKey)` at render time. The list itself is+ * sorted by the English label so the rendered order matches the en.json file.+ */+export interface WebhookEventGroup {+ labelKey: string+ events: readonly string[]+}++export const WEBHOOK_EVENT_GROUPS: readonly WebhookEventGroup[] = [+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.asset',+ events: ['asset.created', 'asset.deleted', 'asset.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.customer',+ events: [+ 'customer.created',+ 'customer.deleted',+ 'customer.password_reset',+ 'customer.password_reset_requested',+ 'customer.updated',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.digital',+ events: [+ 'digital.created',+ 'digital.deleted',+ 'digital.updated',+ 'digital_link.created',+ 'digital_link.deleted',+ 'digital_link.updated',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.gift_card',+ events: [+ 'gift_card.created',+ 'gift_card.deleted',+ 'gift_card.partially_redeemed',+ 'gift_card.redeemed',+ 'gift_card.updated',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.gift_card_batch',+ events: ['gift_card_batch.created', 'gift_card_batch.deleted', 'gift_card_batch.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.import_export',+ events: [+ 'export.created',+ 'export.deleted',+ 'export.updated',+ 'import.completed',+ 'import.created',+ 'import.progress',+ 'import_row.completed',+ 'import_row.failed',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.invitation',+ events: ['invitation.accepted', 'invitation.created', 'invitation.resent'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.line_item',+ events: ['line_item.created', 'line_item.deleted', 'line_item.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.newsletter_subscriber',+ events: [+ 'newsletter_subscriber.created',+ 'newsletter_subscriber.deleted',+ 'newsletter_subscriber.subscription_requested',+ 'newsletter_subscriber.updated',+ 'newsletter_subscriber.verified',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.order',+ events: [+ 'order.approved',+ 'order.canceled',+ 'order.completed',+ 'order.created',+ 'order.deleted',+ 'order.paid',+ 'order.resumed',+ 'order.shipped',+ 'order.updated',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.payment',+ events: [+ 'payment.completed',+ 'payment.created',+ 'payment.deleted',+ 'payment.paid',+ 'payment.updated',+ 'payment.voided',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.payment_session',+ events: [+ 'payment_session.canceled',+ 'payment_session.completed',+ 'payment_session.expired',+ 'payment_session.failed',+ 'payment_session.processing',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.payment_setup_session',+ events: [+ 'payment_setup_session.canceled',+ 'payment_setup_session.completed',+ 'payment_setup_session.expired',+ 'payment_setup_session.failed',+ 'payment_setup_session.processing',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.price',+ events: ['price.created', 'price.deleted', 'price.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.product',+ events: [+ 'product.activated',+ 'product.archived',+ 'product.back_in_stock',+ 'product.created',+ 'product.deleted',+ 'product.out_of_stock',+ 'product.updated',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.promotion',+ events: ['promotion.created', 'promotion.deleted', 'promotion.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.refund',+ events: ['refund.created', 'refund.deleted', 'refund.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.report',+ events: ['report.created', 'report.deleted', 'report.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.return',+ events: [+ 'customer_return.created',+ 'customer_return.deleted',+ 'customer_return.updated',+ 'reimbursement.reimbursed',+ 'return_authorization.canceled',+ 'return_authorization.created',+ 'return_authorization.deleted',+ 'return_authorization.updated',+ 'return_item.canceled',+ 'return_item.given',+ 'return_item.received',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.shipment',+ events: [+ 'shipment.canceled',+ 'shipment.created',+ 'shipment.deleted',+ 'shipment.resumed',+ 'shipment.shipped',+ 'shipment.updated',+ ],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.stock_item',+ events: ['stock_item.created', 'stock_item.deleted', 'stock_item.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.stock_movement',+ events: ['stock_movement.created', 'stock_movement.deleted', 'stock_movement.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.stock_reservation',+ events: ['stock_reservation.created', 'stock_reservation.deleted', 'stock_reservation.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.stock_transfer',+ events: ['stock_transfer.created', 'stock_transfer.deleted', 'stock_transfer.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.store_credit',+ events: ['store_credit.created', 'store_credit.deleted', 'store_credit.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.variant',+ events: ['variant.created', 'variant.deleted', 'variant.updated'],+ },+ {+ labelKey: 'admin.pages.settings.webhooks.event_groups.wishlist',+ events: [+ 'wished_item.created',+ 'wished_item.deleted',+ 'wished_item.updated',+ 'wishlist.created',+ 'wishlist.deleted',+ 'wishlist.updated',+ ],+ },+]diff --git a/packages/dashboard/src/tables/webhook-deliveries.tsx b/packages/dashboard/src/tables/webhook-deliveries.tsxnew file mode 100644index 0000000000..4a17f537ed--- /dev/null+++ b/packages/dashboard/src/tables/webhook-deliveries.tsx@@ -0,0 +1,121 @@+import type { WebhookDelivery } from '@spree/admin-sdk'+import { defineTable } from '@spree/dashboard-core'+import { Badge, RelativeTime } from '@spree/dashboard-ui'+import i18n from 'i18next'+import { ListIcon } from 'lucide-react'++// `success` on a delivery is tri-state: `true` (HTTP 2xx received), `false`+// (response/transport error), or `null` (queued, not yet attempted). The+// table filter exposes the two non-pending values so admins can quickly+// triage failures.+const STATUS_OPTIONS = [+ { value: 'true', label: i18n.t('admin.pages.settings.webhooks.deliveries.status.success') },+ { value: 'false', label: i18n.t('admin.pages.settings.webhooks.deliveries.status.failure') },+] as const++defineTable<WebhookDelivery>('webhook-deliveries', {+ title: i18n.t('admin.pages.settings.webhooks.deliveries_sheet_title'),+ searchParam: 'event_name_cont',+ searchPlaceholder: i18n.t('admin.pages.settings.webhooks.deliveries.search_placeholder'),+ // `created_at` (not `delivered_at`) so freshly-queued rows whose+ // `delivered_at` is still null sort to the top. Matches the model's+ // `recent` scope and what an admin opening this dialog expects to see+ // (most recent attempt first, including not-yet-attempted ones).+ defaultSort: { field: 'created_at', direction: 'desc' },+ emptyIcon: <ListIcon className="size-8 text-muted-foreground" />,+ emptyMessage: i18n.t('admin.pages.settings.webhooks.deliveries.empty'),+ columns: [+ {+ key: 'event_name',+ label: i18n.t('admin.pages.settings.webhooks.deliveries.table.event'),+ sortable: true,+ filterable: true,+ default: true,+ render: (delivery) => (+ <button+ type="button"+ // Acts as the row-click target. The detail sheet opens via the+ // parent's `useRowClickBridge('data-webhook-delivery-id', …)`.+ data-webhook-delivery-id={delivery.id}+ className="font-mono text-xs underline-offset-2 hover:underline focus-visible:rounded focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"+ >+ {delivery.event_name}+ </button>+ ),+ },+ {+ key: 'success',+ label: i18n.t('admin.pages.settings.webhooks.deliveries.table.status'),+ sortable: false,+ filterable: true,+ filterType: 'enum',+ filterOptions: [...STATUS_OPTIONS],+ default: true,+ render: (delivery) => {+ if (delivery.delivered_at == null) {+ return (+ <Badge variant="secondary">+ {i18n.t('admin.pages.settings.webhooks.deliveries.status.pending')}+ </Badge>+ )+ }+ if (delivery.success === true) {+ return <Badge>{i18n.t('admin.pages.settings.webhooks.deliveries.status.success')}</Badge>+ }+ if (delivery.error_type) {+ return (+ <Badge variant="destructive">+ {i18n.t('admin.pages.settings.webhooks.deliveries.status.error')}+ </Badge>+ )+ }+ return (+ <Badge variant="destructive">+ {i18n.t('admin.pages.settings.webhooks.deliveries.status.failure')}+ </Badge>+ )+ },+ },+ {+ key: 'response_code',+ label: i18n.t('admin.pages.settings.webhooks.deliveries.table.code'),+ sortable: true,+ filterable: true,+ filterType: 'number',+ default: true,+ render: (delivery) => {+ if (delivery.response_code != null) {+ return <code className="font-mono text-xs">{delivery.response_code}</code>+ }+ if (delivery.error_type) {+ return <span className="text-xs text-muted-foreground">{delivery.error_type}</span>+ }+ return <span className="text-xs text-muted-foreground">—</span>+ },+ },+ {+ key: 'execution_time',+ label: i18n.t('admin.pages.settings.webhooks.deliveries.table.execution_time'),+ sortable: true,+ default: true,+ render: (delivery) =>+ delivery.execution_time != null ? (+ <span className="text-xs text-muted-foreground">{delivery.execution_time}ms</span>+ ) : (+ <span className="text-xs text-muted-foreground">—</span>+ ),+ },+ {+ key: 'delivered_at',+ label: i18n.t('admin.pages.settings.webhooks.deliveries.table.delivered_at'),+ sortable: true,+ default: true,+ render: (delivery) =>+ delivery.delivered_at ? (+ <RelativeTime iso={delivery.delivered_at} />+ ) : (+ <span className="text-xs text-muted-foreground">—</span>+ ),+ },+ ],+})diff --git a/packages/dashboard/src/tables/webhook-endpoints.tsx b/packages/dashboard/src/tables/webhook-endpoints.tsxnew file mode 100644index 0000000000..fc485077b6--- /dev/null+++ b/packages/dashboard/src/tables/webhook-endpoints.tsx@@ -0,0 +1,170 @@+import type { WebhookEndpoint } from '@spree/admin-sdk'+import { defineTable } from '@spree/dashboard-core'+import {+ ActiveBadge,+ Badge,+ CopyToClipboardButton,+ RelativeTime,+ ResourceNameCell,+} from '@spree/dashboard-ui'+import i18n from 'i18next'+import { WebhookIcon } from 'lucide-react'+import { webhookEndpointHealth, webhookHealthBadgeVariant } from '@/lib/webhook-health'++defineTable<WebhookEndpoint>('webhook-endpoints', {+ title: i18n.t('admin.pages.settings.webhooks.title'),+ searchParam: 'url_cont',+ searchPlaceholder: i18n.t('admin.pages.settings.webhooks.search_placeholder'),+ defaultSort: { field: 'created_at', direction: 'desc' },+ emptyIcon: <WebhookIcon className="size-8 text-muted-foreground" />,+ emptyMessage: i18n.t('admin.pages.settings.webhooks.empty_title'),+ columns: [+ {+ key: 'name',+ label: i18n.t('admin.pages.settings.webhooks.table.name'),+ sortable: true,+ filterable: true,+ default: true,+ render: (endpoint) => (+ <ResourceNameCell+ id={endpoint.id}+ dataAttr="data-webhook-endpoint-id"+ name={endpoint.name || endpoint.url}+ />+ ),+ },+ {+ key: 'url',+ label: i18n.t('admin.pages.settings.webhooks.table.url'),+ sortable: true,+ filterable: true,+ default: true,+ render: (endpoint) => (+ <span className="inline-flex items-center gap-1.5">+ <span className="font-mono text-xs text-muted-foreground truncate max-w-md inline-block">+ {endpoint.url}+ </span>+ <CopyToClipboardButton+ value={endpoint.url}+ aria-label={i18n.t('admin.pages.settings.webhooks.table.copy_url_aria')}+ />+ </span>+ ),+ },+ {+ key: 'subscriptions',+ label: i18n.t('admin.pages.settings.webhooks.table.events'),+ sortable: false,+ default: true,+ render: (endpoint) => {+ if (!endpoint.subscriptions || endpoint.subscriptions.length === 0) {+ return (+ <Badge variant="secondary">{i18n.t('admin.pages.settings.webhooks.events_all')}</Badge>+ )+ }+ return (+ <span className="text-sm text-muted-foreground">+ {i18n.t('admin.pages.settings.webhooks.events_count', {+ count: endpoint.subscriptions.length,+ })}+ </span>+ )+ },+ },+ {+ key: 'status',+ label: i18n.t('admin.pages.settings.webhooks.table.status'),+ sortable: false,+ default: true,+ render: (endpoint) => {+ // Auto-disabled is a distinct third state (the SSRF / failure+ // threshold tripped) — surface it with the destructive variant rather+ // than the regular inactive outline so admins can spot it at a glance.+ if (endpoint.disabled_at) {+ return (+ <Badge variant="destructive">+ {i18n.t('admin.pages.settings.webhooks.status.disabled')}+ </Badge>+ )+ }+ return (+ <ActiveBadge+ active={endpoint.active}+ activeLabel={i18n.t('admin.pages.settings.webhooks.status.active')}+ inactiveLabel={i18n.t('admin.pages.settings.webhooks.status.inactive')}+ />+ )+ },+ },+ {+ key: 'health',+ label: i18n.t('admin.pages.settings.webhooks.health.label'),+ sortable: false,+ default: true,+ render: (endpoint) => {+ const bucket = webhookEndpointHealth(endpoint)+ const variant = webhookHealthBadgeVariant(bucket)++ let label: string+ switch (bucket.kind) {+ case 'disabled':+ label = i18n.t('admin.pages.settings.webhooks.health.disabled')+ break+ case 'no_deliveries':+ label = i18n.t('admin.pages.settings.webhooks.health.no_deliveries')+ break+ case 'healthy':+ label = i18n.t('admin.pages.settings.webhooks.health.healthy', {+ percentage: bucket.percentage,+ })+ break+ case 'degraded':+ label = i18n.t('admin.pages.settings.webhooks.health.degraded', {+ percentage: bucket.percentage,+ })+ break+ case 'failing':+ label = i18n.t('admin.pages.settings.webhooks.health.failing', {+ percentage: bucket.percentage,+ })+ break+ }++ const total = endpoint.total_delivery_count ?? 0+ const successful = endpoint.successful_delivery_count ?? 0+ const failed = endpoint.failed_delivery_count ?? 0++ return (+ <div className="flex flex-col gap-1">+ <Badge variant={variant} className="self-start">+ {label}+ </Badge>+ {total > 0 && (+ <span className="text-xs text-muted-foreground">+ {i18n.t('admin.pages.settings.webhooks.health.row_counters_successful', {+ count: successful,+ })}+ {' · '}+ {i18n.t('admin.pages.settings.webhooks.health.row_counters_failed', {+ count: failed,+ })}+ </span>+ )}+ </div>+ )+ },+ },+ {+ key: 'last_delivery_at',+ label: i18n.t('admin.pages.settings.webhooks.table.last_delivery'),+ sortable: false,+ default: true,+ render: (endpoint) =>+ endpoint.last_delivery_at ? (+ <RelativeTime iso={endpoint.last_delivery_at} />+ ) : (+ <span className="text-sm text-muted-foreground">—</span>+ ),+ },+ ],+})diff --git a/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/store_controller.rbindex 495ab82bc9..7f05d3588c 100644--- a/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/store_controller.rb@@ -38,7 +38,12 @@ module Spree:preferred_admin_locale,:preferred_timezone,:preferred_weight_unit,- :preferred_unit_system+ :preferred_unit_system,+ :mail_from_address,+ :customer_support_email,+ :new_order_notifications_email,+ :preferred_send_consumer_transactional_emails,+ :mailer_logo)endenddiff --git a/spree/api/app/controllers/spree/api/v3/admin/webhook_deliveries_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/webhook_deliveries_controller.rbnew file mode 100644index 0000000000..e84a073909--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/admin/webhook_deliveries_controller.rb@@ -0,0 +1,49 @@+module Spree+ module Api+ module V3+ module Admin+ # Nested under WebhookEndpoint — deliveries are always read in the+ # context of their endpoint (the delivery log on the endpoint detail+ # page) and never accessed by ID at the top level.+ class WebhookDeliveriesController < ResourceController+ scoped_resource :settings++ # POST /api/v3/admin/webhook_endpoints/:webhook_endpoint_id/deliveries/:id/redeliver+ #+ # Creates a new delivery row with the same payload + event_name and+ # queues it. The original row is preserved for audit history.+ #+ # @return [Hash] the serialized newly-queued {Spree::WebhookDelivery},+ # HTTP 201.+ def redeliver+ @resource = find_resource+ authorize!(:update, webhook_endpoint)++ new_delivery = @resource.redeliver!+ render json: serialize_resource(new_delivery), status: :created+ end++ protected++ def model_class+ Spree::WebhookDelivery+ end++ def serializer_class+ Spree.api.admin_webhook_delivery_serializer+ end++ def scope+ webhook_endpoint.webhook_deliveries.recent+ end++ def webhook_endpoint+ @webhook_endpoint ||= current_store.webhook_endpoints.find_by_prefix_id!(+ params[:webhook_endpoint_id]+ )+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/admin/webhook_endpoints_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/webhook_endpoints_controller.rbnew file mode 100644index 0000000000..fefffbe7a9--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/admin/webhook_endpoints_controller.rb@@ -0,0 +1,75 @@+module Spree+ module Api+ module V3+ module Admin+ # Admin API for outbound webhook endpoints — CRUD plus the three+ # endpoint-scoped actions the legacy admin had (send_test, enable,+ # disable).+ class WebhookEndpointsController < ResourceController+ scoped_resource :settings++ # POST /api/v3/admin/webhook_endpoints/:id/send_test+ #+ # Fires a synthetic `webhook.test` delivery so admins can verify the+ # endpoint is reachable + their signature-verification code works.+ #+ # @return [Hash] the serialized {Spree::WebhookDelivery}, HTTP 201.+ def send_test+ @resource = find_resource+ authorize!(:update, @resource)++ delivery = @resource.send_test!+ render json: Spree.api.admin_webhook_delivery_serializer.new(delivery).to_h, status: :created+ end++ # PATCH /api/v3/admin/webhook_endpoints/:id/enable+ #+ # Re-enables an endpoint that was auto-disabled after repeated failures.+ #+ # @return [Hash] the serialized {Spree::WebhookEndpoint}.+ def enable+ @resource = find_resource+ authorize!(:update, @resource)++ @resource.enable!+ render json: serialize_resource(@resource)+ end++ # PATCH /api/v3/admin/webhook_endpoints/:id/disable+ #+ # Manual disable — separate from the auto-disable threshold so the+ # caller can pause an endpoint without waiting for failures.+ #+ # @param reason [String] optional human-readable reason; defaults to+ # `"Manually disabled"` when blank.+ # @return [Hash] the serialized {Spree::WebhookEndpoint}.+ def disable+ @resource = find_resource+ authorize!(:update, @resource)++ @resource.disable!(reason: params[:reason].presence || 'Manually disabled', notify: false)+ render json: serialize_resource(@resource)+ end++ protected++ def model_class+ Spree::WebhookEndpoint+ end++ def serializer_class+ Spree.api.admin_webhook_endpoint_serializer+ end++ def scope+ current_store.webhook_endpoints.accessible_by(current_ability, :show)+ end++ def permitted_params+ params.permit(:name, :url, :active, subscriptions: [])+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rbnew file mode 100644index 0000000000..b13b264785--- /dev/null+++ b/spree/api/app/serializers/spree/api/v3/admin/webhook_delivery_serializer.rb@@ -0,0 +1,45 @@+# frozen_string_literal: true++module Spree+ module Api+ module V3+ module Admin+ # Admin API serializer for {Spree::WebhookDelivery}.+ #+ # Surface the delivery log so admins can audit + retry failed webhook+ # attempts. Includes the request payload + response body so they can+ # inspect what was sent and what the endpoint returned.+ class WebhookDeliverySerializer < V3::BaseSerializer+ typelize event_name: :string,+ event_id: [:string, nullable: true],+ response_code: [:number, nullable: true],+ execution_time: [:number, nullable: true],+ error_type: [:string, nullable: true],+ request_errors: [:string, nullable: true],+ response_body: [:string, nullable: true],+ success: [:boolean, nullable: true],+ delivered_at: [:string, nullable: true],+ payload: 'Record<string, unknown>',+ webhook_endpoint_id: :string,+ webhook_endpoint_url: :string++ attributes :event_name, :event_id, :response_code, :execution_time,+ :error_type, :request_errors, :response_body, :success,+ :payload,+ created_at: :iso8601, updated_at: :iso8601,+ delivered_at: :iso8601++ attribute :webhook_endpoint_id do |delivery|+ delivery.webhook_endpoint&.prefixed_id+ end++ # Delegated from the parent endpoint — saves callers from having to+ # join the endpoint payload to show "where did this delivery go?".+ attribute :webhook_endpoint_url do |delivery|+ delivery.webhook_endpoint&.url+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/serializers/spree/api/v3/admin/webhook_endpoint_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/webhook_endpoint_serializer.rbnew file mode 100644index 0000000000..fef2ffd2f8--- /dev/null+++ b/spree/api/app/serializers/spree/api/v3/admin/webhook_endpoint_serializer.rb@@ -0,0 +1,69 @@+# frozen_string_literal: true++module Spree+ module Api+ module V3+ module Admin+ # Admin API serializer for {Spree::WebhookEndpoint}.+ #+ # Never exposes `secret_key` outside of the create response (encrypted+ # at rest, plaintext only in memory after generation). The full secret+ # is delivered exactly once via {#secret_key} below — `nil` everywhere+ # else.+ class WebhookEndpointSerializer < V3::BaseSerializer+ typelize name: [:string, nullable: true],+ url: :string,+ active: :boolean,+ subscriptions: [:string, multi: true],+ secret_key: [:string, nullable: true],+ disabled_at: [:string, nullable: true],+ disabled_reason: [:string, nullable: true],+ last_delivery_at: [:string, nullable: true],+ recent_delivery_count: :number,+ recent_failure_count: :number,+ total_delivery_count: :number,+ successful_delivery_count: :number,+ failed_delivery_count: :number++ attributes :name, :url, :active, :subscriptions,+ :disabled_reason,+ created_at: :iso8601, updated_at: :iso8601,+ disabled_at: :iso8601++ # Plaintext on the create response only — the model owns the+ # "fresh-from-create" rule via `secret_key_for_response`. Every+ # subsequent read serializes nil.+ attribute :secret_key, &:secret_key_for_response++ attribute :last_delivery_at do |endpoint|+ value = endpoint.webhook_deliveries.maximum(:delivered_at)+ value.respond_to?(:iso8601) ? value.iso8601 : value+ end++ attribute :recent_delivery_count do |endpoint|+ endpoint.webhook_deliveries.where(created_at: 7.days.ago..).count+ end++ attribute :recent_failure_count do |endpoint|+ endpoint.webhook_deliveries.where(created_at: 7.days.ago.., success: false).count+ end++ # Lifetime totals — back the health summary panel on the endpoint+ # detail sheet (success % over all deliveries, like the legacy admin's+ # `_summary.html.erb`).+ attribute :total_delivery_count do |endpoint|+ endpoint.webhook_deliveries.count+ end++ attribute :successful_delivery_count do |endpoint|+ endpoint.webhook_deliveries.successful.count+ end++ attribute :failed_delivery_count do |endpoint|+ endpoint.webhook_deliveries.failed.count+ end+ end+ end+ end+ end+enddiff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rbindex 61ad558976..4c456d6485 100644--- a/spree/api/config/routes.rb+++ b/spree/api/config/routes.rb@@ -141,6 +141,18 @@ Spree::Core::Engine.add_routes doendendresources :allowed_origins+ resources :webhook_endpoints do+ member do+ post :send_test+ patch :enable+ patch :disable+ end+ resources :deliveries, controller: 'webhook_deliveries', only: [:index, :show] do+ member do+ post :redeliver+ end+ end+ endresources :roles, only: [:index, :show]# Direct Uploads (Active Storage)diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rbindex 6d497a314b..3168e517c6 100644--- a/spree/api/lib/spree/api/dependencies.rb+++ b/spree/api/lib/spree/api/dependencies.rb@@ -209,6 +209,8 @@ module Spreeadmin_store_serializer: 'Spree::Api::V3::Admin::StoreSerializer',admin_api_key_serializer: 'Spree::Api::V3::Admin::ApiKeySerializer',admin_allowed_origin_serializer: 'Spree::Api::V3::Admin::AllowedOriginSerializer',+ admin_webhook_endpoint_serializer: 'Spree::Api::V3::Admin::WebhookEndpointSerializer',+ admin_webhook_delivery_serializer: 'Spree::Api::V3::Admin::WebhookDeliverySerializer',admin_invitation_serializer: 'Spree::Api::V3::Admin::InvitationSerializer',admin_role_serializer: 'Spree::Api::V3::Admin::RoleSerializer',admin_export_serializer: 'Spree::Api::V3::Admin::ExportSerializer',diff --git a/spree/api/spec/controllers/spree/api/v3/admin/webhook_deliveries_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/webhook_deliveries_controller_spec.rbnew file mode 100644index 0000000000..53a90af42f--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/admin/webhook_deliveries_controller_spec.rb@@ -0,0 +1,73 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Admin::WebhookDeliveriesController, type: :controller do+ render_views++ include_context 'API v3 Admin authenticated'++ before { request.headers.merge!(headers) }++ let(:endpoint) { create(:webhook_endpoint, store: store) }+ let!(:successful_delivery) { create(:webhook_delivery, :successful, webhook_endpoint: endpoint) }+ let!(:failed_delivery) { create(:webhook_delivery, :failed, webhook_endpoint: endpoint) }++ describe 'GET #index' do+ subject { get :index, params: { webhook_endpoint_id: endpoint.prefixed_id }, as: :json }++ it 'returns the deliveries scoped to the endpoint, most-recent-first' do+ subject+ expect(response).to have_http_status(:ok)+ ids = json_response['data'].map { |d| d['id'] }+ expect(ids).to contain_exactly(successful_delivery.prefixed_id, failed_delivery.prefixed_id)+ # `recent` scope orders by created_at DESC; the later-built failed delivery+ # is created last, so it comes first.+ expect(ids.first).to eq(failed_delivery.prefixed_id)+ end++ it 'does not leak deliveries from other endpoints' do+ other = create(:webhook_endpoint, store: store)+ create(:webhook_delivery, :successful, webhook_endpoint: other)++ subject+ expect(json_response['data'].size).to eq(2)+ end+ end++ describe 'GET #show' do+ subject do+ get :show,+ params: { webhook_endpoint_id: endpoint.prefixed_id, id: failed_delivery.prefixed_id },+ as: :json+ end++ it 'returns the delivery with payload, response code, and webhook_endpoint_id' do+ subject+ expect(response).to have_http_status(:ok)+ expect(json_response['response_code']).to eq(500)+ expect(json_response['success']).to eq(false)+ expect(json_response['webhook_endpoint_id']).to eq(endpoint.prefixed_id)+ expect(json_response['payload']).to be_present+ end+ end++ describe 'POST #redeliver' do+ subject do+ post :redeliver,+ params: { webhook_endpoint_id: endpoint.prefixed_id, id: failed_delivery.prefixed_id },+ as: :json+ end++ before do+ allow_any_instance_of(Spree::WebhookDelivery).to receive(:queue_for_delivery!)+ end++ it 'creates a new delivery row with the same payload + event_name' do+ expect { subject }.to change { endpoint.webhook_deliveries.count }.by(1)+ expect(response).to have_http_status(:created)+ new_id = json_response['id']+ new_delivery = Spree::WebhookDelivery.find_by_prefix_id!(new_id)+ expect(new_delivery.payload).to eq(failed_delivery.payload)+ expect(new_delivery.event_name).to eq(failed_delivery.event_name)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/admin/webhook_endpoints_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/webhook_endpoints_controller_spec.rbnew file mode 100644index 0000000000..d0ab2af2a0--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/admin/webhook_endpoints_controller_spec.rb@@ -0,0 +1,140 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Admin::WebhookEndpointsController, type: :controller do+ render_views++ include_context 'API v3 Admin authenticated'++ before { request.headers.merge!(headers) }++ let!(:endpoint) do+ create(:webhook_endpoint, :with_subscriptions, store: store, name: 'Test endpoint')+ end++ describe 'GET #index' do+ subject { get :index, as: :json }++ it 'returns the store webhook endpoints' do+ subject+ expect(response).to have_http_status(:ok)+ expect(json_response['data'].map { |e| e['id'] }).to include(endpoint.prefixed_id)+ end++ it 'never exposes the secret_key on list responses' do+ subject+ list_entry = json_response['data'].find { |e| e['id'] == endpoint.prefixed_id }+ expect(list_entry['secret_key']).to be_nil+ end+ end++ describe 'GET #show' do+ subject { get :show, params: { id: endpoint.prefixed_id }, as: :json }++ it 'returns the endpoint with subscriptions' do+ subject+ expect(response).to have_http_status(:ok)+ expect(json_response['name']).to eq('Test endpoint')+ expect(json_response['subscriptions']).to eq(%w[order.created order.completed product.created])+ end++ context 'with a mix of successful and failed deliveries' do+ before do+ create(:webhook_delivery, :successful, webhook_endpoint: endpoint)+ create(:webhook_delivery, :successful, webhook_endpoint: endpoint)+ create(:webhook_delivery, :failed, webhook_endpoint: endpoint)+ end++ it 'returns the lifetime delivery counters used by the health summary' do+ subject+ expect(json_response['total_delivery_count']).to eq(3)+ expect(json_response['successful_delivery_count']).to eq(2)+ expect(json_response['failed_delivery_count']).to eq(1)+ end+ end+ end++ describe 'POST #create' do+ subject { post :create, params: params, as: :json }++ let(:params) do+ {+ name: 'Order webhooks',+ url: 'https://example.com/hook',+ active: true,+ subscriptions: %w[order.created order.completed]+ }+ end++ it 'creates the endpoint and returns the plaintext secret_key exactly once' do+ expect { subject }.to change(Spree::WebhookEndpoint, :count).by(1)+ expect(response).to have_http_status(:created)+ created = Spree::WebhookEndpoint.last+ expect(json_response['id']).to eq(created.prefixed_id)+ expect(json_response['secret_key']).to be_present+ expect(json_response['secret_key']).to eq(created.secret_key)+ end++ context 'when the url is invalid' do+ let(:params) { { url: 'not-a-url', subscriptions: [] } }++ it 'returns a validation error' do+ subject+ expect(response).to have_http_status(:unprocessable_content)+ expect(json_response['error']['code']).to eq('validation_error')+ end+ end+ end++ describe 'PATCH #update' do+ subject { patch :update, params: { id: endpoint.prefixed_id, **params }, as: :json }++ let(:params) { { name: 'Renamed', active: false } }++ it 'updates editable attributes' do+ subject+ expect(response).to have_http_status(:ok)+ endpoint.reload+ expect(endpoint.name).to eq('Renamed')+ expect(endpoint.active).to eq(false)+ end++ it 'does not return the secret_key on subsequent reads' do+ subject+ expect(json_response['secret_key']).to be_nil+ end+ end++ describe 'DELETE #destroy' do+ subject { delete :destroy, params: { id: endpoint.prefixed_id }, as: :json }++ it 'soft-deletes the endpoint' do+ subject+ expect(response).to have_http_status(:no_content)+ expect(endpoint.reload.deleted_at).to be_present+ end+ end++ describe 'PATCH #disable / #enable' do+ it 'flips the endpoint inactive and back' do+ patch :disable, params: { id: endpoint.prefixed_id }, as: :json+ expect(response).to have_http_status(:ok)+ expect(endpoint.reload.active).to eq(false)+ expect(endpoint.disabled_at).to be_present++ patch :enable, params: { id: endpoint.prefixed_id }, as: :json+ expect(response).to have_http_status(:ok)+ expect(endpoint.reload.active).to eq(true)+ expect(endpoint.disabled_at).to be_nil+ end+ end++ describe 'POST #send_test' do+ subject { post :send_test, params: { id: endpoint.prefixed_id }, as: :json }++ it 'creates a webhook.test delivery and returns it' do+ expect { subject }.to change { endpoint.webhook_deliveries.count }.by(1)+ expect(response).to have_http_status(:created)+ expect(json_response['event_name']).to eq('webhook.test')+ end+ end+enddiff --git a/spree/api/spec/integration/spree/api/v3/admin/webhook_deliveries_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/webhook_deliveries_spec.rbnew file mode 100644index 0000000000..aef9549ad6--- /dev/null+++ b/spree/api/spec/integration/spree/api/v3/admin/webhook_deliveries_spec.rb@@ -0,0 +1,161 @@+# frozen_string_literal: true++require 'swagger_helper'++RSpec.describe 'Admin Webhook Deliveries API', type: :request, swagger_doc: 'api-reference/admin.yaml' do+ include_context 'API v3 Admin'++ let(:Authorization) { "Bearer #{admin_jwt_token}" }+ let!(:webhook_endpoint) do+ create(:webhook_endpoint, store: store, name: 'Order pipeline', url: 'https://shop.example.com/webhooks')+ end+ let!(:successful_delivery) { create(:webhook_delivery, :successful, webhook_endpoint: webhook_endpoint) }+ let!(:failed_delivery) { create(:webhook_delivery, :failed, webhook_endpoint: webhook_endpoint) }++ path '/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries' do+ parameter name: :webhook_endpoint_id, in: :path, type: :string, required: true,+ description: 'Parent webhook endpoint ID'++ get 'List webhook deliveries' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Returns delivery attempts for the given endpoint, most recent first.+ Each row carries the original request payload, the response code+ (when the receiver replied), the execution time, and any transport+ error — everything needed to audit failures and decide whether to+ redeliver.+ DESC+ admin_scope :read, :settings++ admin_sdk_example 'webhook-endpoints/deliveries/list'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'+ parameter name: :limit, in: :query, type: :integer, required: false, description: 'Number of records per page'+ parameter name: :'q[event_name_eq]', in: :query, type: :string, required: false,+ description: 'Filter by event name (exact)'+ parameter name: :'q[success_eq]', in: :query, type: :boolean, required: false,+ description: 'Filter by success flag'+ parameter name: :sort, in: :query, type: :string, required: false,+ description: 'Sort by field. Prefix with `-` for descending (e.g., `-delivered_at`).'+ parameter name: :fields, in: :query, type: :string, required: false,+ description: 'Comma-separated list of fields to include. id is always included.'++ response '200', 'deliveries found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:webhook_endpoint_id) { webhook_endpoint.prefixed_id }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['data']).to be_an(Array)+ ids = data['data'].map { |d| d['id'] }+ expect(ids).to include(successful_delivery.prefixed_id, failed_delivery.prefixed_id)+ end+ end++ response '404', 'parent webhook endpoint not found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:webhook_endpoint_id) { 'whe_nonexistent' }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end+ end++ path '/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}' do+ parameter name: :webhook_endpoint_id, in: :path, type: :string, required: true,+ description: 'Parent webhook endpoint ID'+ parameter name: :id, in: :path, type: :string, required: true, description: 'Webhook delivery ID'++ get 'Get a webhook delivery' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Returns a single delivery attempt with the full request payload and+ the response body the receiver returned. Use this for ad-hoc debug+ of failed deliveries.+ DESC+ admin_scope :read, :settings++ admin_sdk_example 'webhook-endpoints/deliveries/get'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :fields, in: :query, type: :string, required: false,+ description: 'Comma-separated list of fields to include. id is always included.'++ response '200', 'delivery found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:webhook_endpoint_id) { webhook_endpoint.prefixed_id }+ let(:id) { failed_delivery.prefixed_id }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['id']).to eq(failed_delivery.prefixed_id)+ expect(data['success']).to eq(false)+ expect(data['response_code']).to eq(500)+ expect(data['webhook_endpoint_id']).to eq(webhook_endpoint.prefixed_id)+ expect(data['payload']).to be_present+ end+ end++ response '404', 'delivery not found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:webhook_endpoint_id) { webhook_endpoint.prefixed_id }+ let(:id) { 'whd_nonexistent' }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end+ end++ path '/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}/redeliver' do+ parameter name: :webhook_endpoint_id, in: :path, type: :string, required: true,+ description: 'Parent webhook endpoint ID'+ parameter name: :id, in: :path, type: :string, required: true,+ description: 'Webhook delivery ID to redeliver'++ post 'Redeliver a webhook delivery' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Creates a new delivery row with the same payload + event_name and+ queues it. The original row is preserved for audit history.+ DESC+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/deliveries/redeliver'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'++ response '201', 'redelivery queued' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:webhook_endpoint_id) { webhook_endpoint.prefixed_id }+ let(:id) { failed_delivery.prefixed_id }++ before do+ allow_any_instance_of(Spree::WebhookDelivery).to receive(:queue_for_delivery!)+ end++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['id']).not_to eq(failed_delivery.prefixed_id)+ expect(data['event_name']).to eq(failed_delivery.event_name)+ end+ end+ end+ end+enddiff --git a/spree/api/spec/integration/spree/api/v3/admin/webhook_endpoints_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/webhook_endpoints_spec.rbnew file mode 100644index 0000000000..0f01c5e5f9--- /dev/null+++ b/spree/api/spec/integration/spree/api/v3/admin/webhook_endpoints_spec.rb@@ -0,0 +1,363 @@+# frozen_string_literal: true++require 'swagger_helper'++RSpec.describe 'Admin Webhook Endpoints API', type: :request, swagger_doc: 'api-reference/admin.yaml' do+ include_context 'API v3 Admin'++ let(:Authorization) { "Bearer #{admin_jwt_token}" }+ let!(:webhook_endpoint) do+ create(+ :webhook_endpoint,+ :with_subscriptions,+ store: store,+ name: 'Order pipeline',+ url: 'https://shop.example.com/webhooks/orders'+ )+ end++ path '/api/v3/admin/webhook_endpoints' do+ get 'List webhook endpoints' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Returns outbound webhook subscriptions for the current store. Each+ endpoint receives a signed POST when any subscribed event fires.+ `secret_key` is `null` on list reads — the plaintext is delivered+ exactly once on create.+ DESC+ admin_scope :read, :settings++ admin_sdk_example 'webhook-endpoints/list'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'+ parameter name: :limit, in: :query, type: :integer, required: false, description: 'Number of records per page'+ parameter name: :'q[name_cont]', in: :query, type: :string, required: false,+ description: 'Filter by name (contains)'+ parameter name: :'q[url_cont]', in: :query, type: :string, required: false,+ description: 'Filter by URL (contains)'+ parameter name: :sort, in: :query, type: :string, required: false,+ description: 'Sort by field. Prefix with `-` for descending (e.g., `-created_at`).'+ parameter name: :fields, in: :query, type: :string, required: false,+ description: 'Comma-separated list of fields to include. id is always included.'++ response '200', 'webhook endpoints found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['data']).to be_an(Array)+ expect(data['data'].map { |e| e['id'] }).to include(webhook_endpoint.prefixed_id)++ # `secret_key` is the encrypted signing secret — never returned+ # outside the one-shot create response.+ data['data'].each do |endpoint|+ expect(endpoint['secret_key']).to be_nil+ end+ end+ end++ response '401', 'unauthorized' do+ let(:'x-spree-api-key') { 'invalid' }+ let(:Authorization) { 'Bearer invalid' }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end++ post 'Create a webhook endpoint' do+ tags 'Configuration'+ consumes 'application/json'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Creates a new outbound webhook subscription. The plaintext+ `secret_key` is returned **once** in this response — persist it+ immediately to verify incoming webhook signatures. Subsequent reads+ return `null` for the secret. Pass an empty `subscriptions` array or+ omit it to receive every event.+ DESC+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/create'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :body, in: :body, schema: {+ type: :object,+ required: %w[url],+ properties: {+ name: { type: :string, example: 'Order pipeline' },+ url: { type: :string, example: 'https://example.com/webhooks/orders' },+ active: { type: :boolean, example: true },+ subscriptions: {+ type: :array,+ items: { type: :string },+ example: %w[order.completed order.canceled]+ }+ }+ }++ response '201', 'webhook endpoint created — secret_key returned once' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:body) do+ {+ name: 'CI integration',+ url: 'https://ci.example.com/webhooks',+ subscriptions: ['order.completed']+ }+ end++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['name']).to eq('CI integration')+ expect(data['url']).to eq('https://ci.example.com/webhooks')+ expect(data['subscriptions']).to eq(['order.completed'])+ expect(data['secret_key']).to be_present+ end+ end++ response '422', 'validation error' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:body) { { url: 'not a url' } }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end+ end++ path '/api/v3/admin/webhook_endpoints/{id}' do+ parameter name: :id, in: :path, type: :string, required: true, description: 'Webhook endpoint ID'++ get 'Get a webhook endpoint' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description 'Returns a single webhook endpoint by prefixed ID.'+ admin_scope :read, :settings++ admin_sdk_example 'webhook-endpoints/get'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :fields, in: :query, type: :string, required: false,+ description: 'Comma-separated list of fields to include. id is always included.'++ response '200', 'webhook endpoint found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['id']).to eq(webhook_endpoint.prefixed_id)+ expect(data['name']).to eq('Order pipeline')+ expect(data['secret_key']).to be_nil+ expect(data).to include(+ 'total_delivery_count',+ 'successful_delivery_count',+ 'failed_delivery_count'+ )+ end+ end++ response '404', 'webhook endpoint not found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { 'whe_nonexistent' }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end++ patch 'Update a webhook endpoint' do+ tags 'Configuration'+ consumes 'application/json'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Updates name, URL, active flag, or the event subscription list.+ Toggling `active` here is equivalent to calling `disable`/`enable`+ without an audit reason.+ DESC+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/update'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :body, in: :body, schema: {+ type: :object,+ properties: {+ name: { type: :string },+ url: { type: :string },+ active: { type: :boolean },+ subscriptions: { type: :array, items: { type: :string } }+ }+ }++ response '200', 'webhook endpoint updated' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }+ let(:body) { { name: 'Order pipeline (renamed)' } }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['name']).to eq('Order pipeline (renamed)')+ end+ end++ response '422', 'validation error' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }+ let(:body) { { url: 'not a url' } }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end++ delete 'Delete a webhook endpoint' do+ tags 'Configuration'+ security [api_key: [], bearer_auth: []]+ description 'Soft-deletes the endpoint and stops future deliveries.'+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/delete'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'++ response '204', 'webhook endpoint deleted' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }++ run_test!+ end+ end+ end++ path '/api/v3/admin/webhook_endpoints/{id}/send_test' do+ parameter name: :id, in: :path, type: :string, required: true, description: 'Webhook endpoint ID'++ post 'Send a test delivery' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Creates a `webhook.test` delivery record and queues it. Use this to+ verify the endpoint is reachable and your signature verification+ accepts Spree's payloads.+ DESC+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/send-test'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'++ response '201', 'test delivery queued' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }++ before do+ # The model enqueues a background job — stub it so the request spec+ # doesn't need an active queue adapter.+ allow_any_instance_of(Spree::WebhookDelivery).to receive(:queue_for_delivery!)+ end++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['event_name']).to eq('webhook.test')+ expect(data['webhook_endpoint_id']).to eq(webhook_endpoint.prefixed_id)+ end+ end+ end+ end++ path '/api/v3/admin/webhook_endpoints/{id}/enable' do+ parameter name: :id, in: :path, type: :string, required: true, description: 'Webhook endpoint ID'++ patch 'Re-enable a webhook endpoint' do+ tags 'Configuration'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description 'Re-enables an endpoint that was manually or automatically disabled.'+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/enable'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'++ response '200', 'webhook endpoint enabled' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }++ before { webhook_endpoint.update!(active: false, disabled_at: Time.current, disabled_reason: 'Failed') }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['active']).to eq(true)+ expect(data['disabled_at']).to be_nil+ end+ end+ end+ end++ path '/api/v3/admin/webhook_endpoints/{id}/disable' do+ parameter name: :id, in: :path, type: :string, required: true, description: 'Webhook endpoint ID'++ patch 'Disable a webhook endpoint' do+ tags 'Configuration'+ consumes 'application/json'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description <<~DESC+ Manually pauses an endpoint. Unlike auto-disable (triggered after+ repeated delivery failures), no notification email is sent.+ DESC+ admin_scope :write, :settings++ admin_sdk_example 'webhook-endpoints/disable'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'+ parameter name: :body, in: :body, schema: {+ type: :object,+ properties: {+ reason: { type: :string, example: 'Investigating elevated 5xx rate' }+ }+ }++ response '200', 'webhook endpoint disabled' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { webhook_endpoint.prefixed_id }+ let(:body) { { reason: 'Investigating' } }++ run_test! do |response|+ data = JSON.parse(response.body)+ expect(data['active']).to eq(false)+ expect(data['disabled_at']).to be_present+ expect(data['disabled_reason']).to eq('Investigating')+ end+ end+ end+ end+enddiff --git a/spree/core/app/models/spree/permission_sets/configuration_management.rb b/spree/core/app/models/spree/permission_sets/configuration_management.rbindex 21772033f8..ce3d87a11b 100644--- a/spree/core/app/models/spree/permission_sets/configuration_management.rb+++ b/spree/core/app/models/spree/permission_sets/configuration_management.rb@@ -36,6 +36,10 @@ module Spree# docs/plans/5.5-admin-auth-cookie-refresh.md).can :manage, Spree::AllowedOrigin+ # Webhooks+ can :manage, Spree::WebhookEndpoint+ can :manage, Spree::WebhookDelivery+# General configurationcan :manage, Spree::RefundReasoncan :manage, Spree::ReimbursementTypediff --git a/spree/core/app/models/spree/webhook_delivery.rb b/spree/core/app/models/spree/webhook_delivery.rbindex ec231dbfe5..dbe10ea898 100644--- a/spree/core/app/models/spree/webhook_delivery.rb+++ b/spree/core/app/models/spree/webhook_delivery.rb@@ -19,7 +19,7 @@ module Spreescope :for_event, ->(event_name) { where(event_name: event_name) }# Ransack configuration- self.whitelisted_ransackable_attributes = %w[event_name response_code execution_time success delivered_at]+ self.whitelisted_ransackable_attributes = %w[event_name response_code execution_time success delivered_at created_at]# Check if the delivery was successful#diff --git a/spree/core/app/models/spree/webhook_endpoint.rb b/spree/core/app/models/spree/webhook_endpoint.rbindex 271a7a4d86..08e3cfa3ea 100644--- a/spree/core/app/models/spree/webhook_endpoint.rb+++ b/spree/core/app/models/spree/webhook_endpoint.rb@@ -22,6 +22,7 @@ module Spreevalidate :url_must_not_resolve_to_private_ip, if: -> { !Rails.env.development? && url.present? && url_changed? }before_create :generate_secret_key+ after_create { @reveal_secret_in_response = true }self.whitelisted_ransackable_attributes = %w[name url active]@@ -29,6 +30,17 @@ module Spreescope :inactive, -> { where(active: false) }scope :enabled, -> { active.where(disabled_at: nil) }+ # Returns the plaintext `secret_key` only on the create response.+ #+ # `@reveal_secret_in_response` is set by the `after_create` callback above+ # — a per-instance flag, not derived from `previous_changes`, so a reload+ # or any subsequent save can't accidentally re-expose the secret.+ #+ # @return [String, nil]+ def secret_key_for_response+ @reveal_secret_in_response ? secret_key : nil+ end+# Number of consecutive failed deliveries before auto-disablingAUTO_DISABLE_THRESHOLD = 15