@adobe/aio-commerce-lib-webhooks 1.1.2 → 1.2.0-beta-20260714082406

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @adobe/aio-commerce-lib-webhooks
 
+## 1.2.0-beta-20260714082406
+### Minor Changes
+
+
+
+- [#563](https://github.com/adobe/aio-commerce-sdk/pull/563) [`19400fb`](https://github.com/adobe/aio-commerce-sdk/commit/19400fbdfc03c5bbfc30f995a2acdd4272c5e032) Thanks [@obarcelonap](https://github.com/obarcelonap)! - Add webhook response helpers to identify webhook success responses and determine whether webhook action responses represent successful outcomes.
+
+
+### Patch Changes
+
+- Updated dependencies [[`19400fb`](https://github.com/adobe/aio-commerce-sdk/commit/19400fbdfc03c5bbfc30f995a2acdd4272c5e032), [`ce7768e`](https://github.com/adobe/aio-commerce-sdk/commit/ce7768e0ddc6ca35ad6ccec60f584c8bb5a743f0), [`4396a64`](https://github.com/adobe/aio-commerce-sdk/commit/4396a647ad22dba063cdf03a16e04aef9387212f), [`e85bec4`](https://github.com/adobe/aio-commerce-sdk/commit/e85bec40f1eaa91dd6bb7bc6954b2ecfc3ea4029), [`413da36`](https://github.com/adobe/aio-commerce-sdk/commit/413da36dcd83e5a41c194f5af50611097659e725)]:
+  - @adobe/aio-commerce-lib-core@1.2.0-beta-20260714082406
+  - @adobe/aio-commerce-lib-api@1.3.0-beta-20260714082406
+
 ## 1.1.2
 
 ### Patch Changes

package/dist/cjs/api/index.cjs

@@ -71,8 +71,8 @@ const WebhookHeaderSchema = valibot.object({
 const DeveloperConsoleOAuthSchema = valibot.object({
 	client_id: nonEmptyString("client_id"),
 	client_secret: nonEmptyString("client_secret"),
-	org_id: nonEmptyString("org_id"),
-	environment: optionalString("environment")
+	environment: optionalString("environment"),
+	org_id: nonEmptyString("org_id")
 });
 /**
 * Schema for the webhook payload sent to POST /webhooks/subscribe.
@@ -80,33 +80,33 @@ const DeveloperConsoleOAuthSchema = valibot.object({
 * Required fields per the Commerce API: webhook_method, webhook_type, batch_name, hook_name, url.
 */
 const WebhookSubscribeParamsSchema = valibot.object({
-	webhook_method: nonEmptyString("webhook_method"),
-	webhook_type: nonEmptyString("webhook_type"),
 	batch_name: nonEmptyString("batch_name"),
 	batch_order: valibot.optional(valibot.number()),
+	developer_console_oauth: valibot.optional(DeveloperConsoleOAuthSchema),
+	fallback_error_message: optionalString("fallback_error_message"),
+	fields: valibot.optional(valibot.array(WebhookFieldSchema, "Expected an array of field objects")),
+	headers: valibot.optional(valibot.array(WebhookHeaderSchema, "Expected an array of header objects")),
 	hook_name: nonEmptyString("hook_name"),
-	url: nonEmptyString("url"),
+	method: optionalString("method"),
 	priority: valibot.optional(valibot.number()),
 	required: valibot.optional(valibot.boolean()),
+	rules: valibot.optional(valibot.array(WebhookRuleSchema, "Expected an array of rule objects")),
 	soft_timeout: valibot.optional(valibot.number()),
 	timeout: valibot.optional(valibot.number()),
-	method: optionalString("method"),
-	fallback_error_message: optionalString("fallback_error_message"),
 	ttl: valibot.optional(valibot.number()),
-	fields: valibot.optional(valibot.array(WebhookFieldSchema, "Expected an array of field objects")),
-	rules: valibot.optional(valibot.array(WebhookRuleSchema, "Expected an array of rule objects")),
-	headers: valibot.optional(valibot.array(WebhookHeaderSchema, "Expected an array of header objects")),
-	developer_console_oauth: valibot.optional(DeveloperConsoleOAuthSchema)
+	url: nonEmptyString("url"),
+	webhook_method: nonEmptyString("webhook_method"),
+	webhook_type: nonEmptyString("webhook_type")
 });
 /**
 * Schema for the parameters sent to POST /webhooks/unsubscribe.
 * Required: webhook_method, webhook_type, batch_name, hook_name.
 */
 const WebhookUnsubscribeParamsSchema = valibot.object({
-	webhook_method: nonEmptyString("webhook_method"),
-	webhook_type: nonEmptyString("webhook_type"),
 	batch_name: nonEmptyString("batch_name"),
-	hook_name: nonEmptyString("hook_name")
+	hook_name: nonEmptyString("hook_name"),
+	webhook_method: nonEmptyString("webhook_method"),
+	webhook_type: nonEmptyString("webhook_type")
 });
 
 //#endregion
@@ -176,10 +176,10 @@ function getSupportedWebhookList(httpClient, fetchOptions) {
 */
 function createCommerceWebhooksApiClient(params) {
 	return _adobe_aio_commerce_lib_api.ApiClient.create(new _adobe_aio_commerce_lib_api.AdobeCommerceHttpClient(params), {
+		getSupportedWebhookList,
 		getWebhookList,
 		subscribeWebhook,
-		unsubscribeWebhook,
-		getSupportedWebhookList
+		unsubscribeWebhook
 	});
 }
 /**

package/dist/cjs/api/index.d.cts

@@ -23,48 +23,48 @@ import * as v from "valibot";
  * Required fields per the Commerce API: webhook_method, webhook_type, batch_name, hook_name, url.
  */
 declare const WebhookSubscribeParamsSchema: v.ObjectSchema<{
-  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly batch_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly batch_order: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly url: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-  readonly soft_timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly method: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  readonly developer_console_oauth: v.OptionalSchema<v.ObjectSchema<{
+    readonly client_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly client_secret: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly environment: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+    readonly org_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  }, undefined>, undefined>;
   readonly fallback_error_message: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
-  readonly ttl: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
   readonly fields: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
     readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
     readonly source: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
   }, undefined>, "Expected an array of field objects">, undefined>;
+  readonly headers: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly value: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  }, undefined>, "Expected an array of header objects">, undefined>;
+  readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly method: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
   readonly rules: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
     readonly field: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
     readonly operator: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
     readonly value: v.StringSchema<"Expected a string for rule value">;
   }, undefined>, "Expected an array of rule objects">, undefined>;
-  readonly headers: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
-    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly value: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  }, undefined>, "Expected an array of header objects">, undefined>;
-  readonly developer_console_oauth: v.OptionalSchema<v.ObjectSchema<{
-    readonly client_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly client_secret: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly org_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly environment: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
-  }, undefined>, undefined>;
+  readonly soft_timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly ttl: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly url: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
 }, undefined>;
 /**
  * Schema for the parameters sent to POST /webhooks/unsubscribe.
  * Required: webhook_method, webhook_type, batch_name, hook_name.
  */
 declare const WebhookUnsubscribeParamsSchema: v.ObjectSchema<{
-  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly batch_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
 }, undefined>;
 /**
  * The parameters for POST /webhooks/subscribe.
@@ -178,10 +178,10 @@ declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fe
  * @param params - The parameters to build the Commerce HTTP client.
  */
 declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, {
+  getSupportedWebhookList: typeof getSupportedWebhookList;
   getWebhookList: typeof getWebhookList;
   subscribeWebhook: typeof subscribeWebhook;
   unsubscribeWebhook: typeof unsubscribeWebhook;
-  getSupportedWebhookList: typeof getSupportedWebhookList;
 }>;
 /**
  * An API client for the Commerce Webhooks API.

package/dist/cjs/responses/index.cjs

@@ -13,8 +13,78 @@
  */
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let _adobe_aio_commerce_lib_api_utils = require("@adobe/aio-commerce-lib-api/utils");
 let _adobe_aio_commerce_lib_core_responses = require("@adobe/aio-commerce-lib-core/responses");
 
+//#region source/responses/operations/types.ts
+function isRecord$1(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+* Determines whether a value is a webhook operation response.
+*
+* @param body - Value to inspect.
+* @returns True when the value matches one of the webhook operation response shapes.
+*/
+function isWebhookOperationResponse(body) {
+	if (!isRecord$1(body)) return false;
+	const { op, path } = body;
+	if (op === "success" || op === "exception") return true;
+	if (op === "add" || op === "replace") return typeof path === "string" && "value" in body;
+	return op === "remove" && typeof path === "string";
+}
+/**
+* Determines whether a value is an array of webhook operation responses.
+*
+* @param body - Value to inspect.
+* @returns True when every array item matches a webhook operation response shape.
+*/
+function isWebhookOperationResponseArray(body) {
+	return Array.isArray(body) && body.every(isWebhookOperationResponse);
+}
+
+//#endregion
+//#region source/responses/types.ts
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+* Determines whether a value is a successful SDK response containing webhook operation response body data.
+*
+* @param response - Value to inspect.
+* @returns True when the value matches the webhook success response shape.
+*/
+function isWebhookSuccessResponse(response) {
+	return isRecord(response) && response.type === "success" && response.statusCode === _adobe_aio_commerce_lib_api_utils.HTTP_OK && (response.body === void 0 || isWebhookOperationResponse(response.body) || isWebhookOperationResponseArray(response.body));
+}
+
+//#endregion
+//#region source/responses/helpers.ts
+/**
+* Determines whether a webhook action's result represents a successful outcome.
+* Adobe Commerce webhooks always respond with HTTP 200, even when the handler
+* wants to block the triggering process, so the actual outcome is only visible
+* in the response body's `op` field (`op: "exception"` signals a failure).
+*
+* @param result - The result of the instrumented webhook action.
+* @returns True if the webhook response is successful, false otherwise.
+*
+* @example
+* ```typescript
+* import { isWebhookSuccessful } from "@adobe/aio-commerce-lib-webhooks/responses";
+*
+* const result = await runWebhookAction(params);
+* span.setStatus(isWebhookSuccessful(result) ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR });
+* ```
+*/
+function isWebhookSuccessful(result) {
+	if (!isWebhookSuccessResponse(result)) return false;
+	if (!result.body) return true;
+	if (Array.isArray(result.body)) return result.body.every((operation) => operation.op !== "exception");
+	return result.body.op !== "exception";
+}
+
+//#endregion
 //#region source/responses/operations/presets.ts
 /**
 * Creates a success operation response
@@ -142,6 +212,8 @@ function ok(operations) {
 //#endregion
 exports.addOperation = addOperation;
 exports.exceptionOperation = exceptionOperation;
+exports.isWebhookSuccessResponse = isWebhookSuccessResponse;
+exports.isWebhookSuccessful = isWebhookSuccessful;
 exports.ok = ok;
 exports.removeOperation = removeOperation;
 exports.replaceOperation = replaceOperation;

package/dist/cjs/responses/index.d.cts

@@ -13,7 +13,28 @@
  */
 
 import { SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
+import { HTTP_OK } from "@adobe/aio-commerce-lib-api/utils";
 
+//#region source/responses/helpers.d.ts
+/**
+ * Determines whether a webhook action's result represents a successful outcome.
+ * Adobe Commerce webhooks always respond with HTTP 200, even when the handler
+ * wants to block the triggering process, so the actual outcome is only visible
+ * in the response body's `op` field (`op: "exception"` signals a failure).
+ *
+ * @param result - The result of the instrumented webhook action.
+ * @returns True if the webhook response is successful, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isWebhookSuccessful } from "@adobe/aio-commerce-lib-webhooks/responses";
+ *
+ * const result = await runWebhookAction(params);
+ * span.setStatus(isWebhookSuccessful(result) ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR });
+ * ```
+ */
+declare function isWebhookSuccessful(result: unknown): boolean;
+//#endregion
 //#region source/responses/operations/types.d.ts
 /**
  * Success operation response
@@ -172,4 +193,20 @@ declare const removeOperation: (path: string) => RemoveOperation;
  */
 declare function ok<TValue = unknown>(operations: WebhookOperationResponse<TValue> | WebhookOperationResponse[]): SuccessResponse;
 //#endregion
-export { type AddOperation, type ExceptionOperation, type RemoveOperation, type ReplaceOperation, type SuccessOperation, type WebhookOperationResponse, addOperation, exceptionOperation, ok, removeOperation, replaceOperation, successOperation };
+//#region source/responses/types.d.ts
+/**
+ * Successful SDK response containing webhook operation response body data.
+ */
+type WebhookSuccessResponse = Omit<SuccessResponse, "body" | "statusCode"> & {
+  body?: WebhookOperationResponse | WebhookOperationResponse[];
+  statusCode: typeof HTTP_OK;
+};
+/**
+ * Determines whether a value is a successful SDK response containing webhook operation response body data.
+ *
+ * @param response - Value to inspect.
+ * @returns True when the value matches the webhook success response shape.
+ */
+declare function isWebhookSuccessResponse(response: unknown): response is WebhookSuccessResponse;
+//#endregion
+export { type AddOperation, type ExceptionOperation, type RemoveOperation, type ReplaceOperation, type SuccessOperation, type WebhookOperationResponse, type WebhookSuccessResponse, addOperation, exceptionOperation, isWebhookSuccessResponse, isWebhookSuccessful, ok, removeOperation, replaceOperation, successOperation };

package/dist/es/api/index.d.mts

@@ -23,48 +23,48 @@ import { Options } from "ky";
  * Required fields per the Commerce API: webhook_method, webhook_type, batch_name, hook_name, url.
  */
 declare const WebhookSubscribeParamsSchema: v.ObjectSchema<{
-  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly batch_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly batch_order: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly url: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-  readonly soft_timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-  readonly method: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  readonly developer_console_oauth: v.OptionalSchema<v.ObjectSchema<{
+    readonly client_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly client_secret: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly environment: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+    readonly org_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  }, undefined>, undefined>;
   readonly fallback_error_message: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
-  readonly ttl: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
   readonly fields: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
     readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
     readonly source: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
   }, undefined>, "Expected an array of field objects">, undefined>;
+  readonly headers: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly value: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  }, undefined>, "Expected an array of header objects">, undefined>;
+  readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly method: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
   readonly rules: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
     readonly field: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
     readonly operator: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
     readonly value: v.StringSchema<"Expected a string for rule value">;
   }, undefined>, "Expected an array of rule objects">, undefined>;
-  readonly headers: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
-    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly value: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  }, undefined>, "Expected an array of header objects">, undefined>;
-  readonly developer_console_oauth: v.OptionalSchema<v.ObjectSchema<{
-    readonly client_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly client_secret: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly org_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-    readonly environment: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
-  }, undefined>, undefined>;
+  readonly soft_timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly ttl: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly url: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
 }, undefined>;
 /**
  * Schema for the parameters sent to POST /webhooks/unsubscribe.
  * Required: webhook_method, webhook_type, batch_name, hook_name.
  */
 declare const WebhookUnsubscribeParamsSchema: v.ObjectSchema<{
-  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
-  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly batch_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
   readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
 }, undefined>;
 /**
  * The parameters for POST /webhooks/subscribe.
@@ -178,10 +178,10 @@ declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fe
  * @param params - The parameters to build the Commerce HTTP client.
  */
 declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, {
+  getSupportedWebhookList: typeof getSupportedWebhookList;
   getWebhookList: typeof getWebhookList;
   subscribeWebhook: typeof subscribeWebhook;
   unsubscribeWebhook: typeof unsubscribeWebhook;
-  getSupportedWebhookList: typeof getSupportedWebhookList;
 }>;
 /**
  * An API client for the Commerce Webhooks API.

package/dist/es/api/index.mjs

@@ -42,8 +42,8 @@ const WebhookHeaderSchema = v.object({
 const DeveloperConsoleOAuthSchema = v.object({
 	client_id: nonEmptyString("client_id"),
 	client_secret: nonEmptyString("client_secret"),
-	org_id: nonEmptyString("org_id"),
-	environment: optionalString("environment")
+	environment: optionalString("environment"),
+	org_id: nonEmptyString("org_id")
 });
 /**
 * Schema for the webhook payload sent to POST /webhooks/subscribe.
@@ -51,33 +51,33 @@ const DeveloperConsoleOAuthSchema = v.object({
 * Required fields per the Commerce API: webhook_method, webhook_type, batch_name, hook_name, url.
 */
 const WebhookSubscribeParamsSchema = v.object({
-	webhook_method: nonEmptyString("webhook_method"),
-	webhook_type: nonEmptyString("webhook_type"),
 	batch_name: nonEmptyString("batch_name"),
 	batch_order: v.optional(v.number()),
+	developer_console_oauth: v.optional(DeveloperConsoleOAuthSchema),
+	fallback_error_message: optionalString("fallback_error_message"),
+	fields: v.optional(v.array(WebhookFieldSchema, "Expected an array of field objects")),
+	headers: v.optional(v.array(WebhookHeaderSchema, "Expected an array of header objects")),
 	hook_name: nonEmptyString("hook_name"),
-	url: nonEmptyString("url"),
+	method: optionalString("method"),
 	priority: v.optional(v.number()),
 	required: v.optional(v.boolean()),
+	rules: v.optional(v.array(WebhookRuleSchema, "Expected an array of rule objects")),
 	soft_timeout: v.optional(v.number()),
 	timeout: v.optional(v.number()),
-	method: optionalString("method"),
-	fallback_error_message: optionalString("fallback_error_message"),
 	ttl: v.optional(v.number()),
-	fields: v.optional(v.array(WebhookFieldSchema, "Expected an array of field objects")),
-	rules: v.optional(v.array(WebhookRuleSchema, "Expected an array of rule objects")),
-	headers: v.optional(v.array(WebhookHeaderSchema, "Expected an array of header objects")),
-	developer_console_oauth: v.optional(DeveloperConsoleOAuthSchema)
+	url: nonEmptyString("url"),
+	webhook_method: nonEmptyString("webhook_method"),
+	webhook_type: nonEmptyString("webhook_type")
 });
 /**
 * Schema for the parameters sent to POST /webhooks/unsubscribe.
 * Required: webhook_method, webhook_type, batch_name, hook_name.
 */
 const WebhookUnsubscribeParamsSchema = v.object({
-	webhook_method: nonEmptyString("webhook_method"),
-	webhook_type: nonEmptyString("webhook_type"),
 	batch_name: nonEmptyString("batch_name"),
-	hook_name: nonEmptyString("hook_name")
+	hook_name: nonEmptyString("hook_name"),
+	webhook_method: nonEmptyString("webhook_method"),
+	webhook_type: nonEmptyString("webhook_type")
 });
 
 //#endregion
@@ -147,10 +147,10 @@ function getSupportedWebhookList(httpClient, fetchOptions) {
 */
 function createCommerceWebhooksApiClient(params) {
 	return ApiClient.create(new AdobeCommerceHttpClient(params), {
+		getSupportedWebhookList,
 		getWebhookList,
 		subscribeWebhook,
-		unsubscribeWebhook,
-		getSupportedWebhookList
+		unsubscribeWebhook
 	});
 }
 /**

package/dist/es/responses/index.d.mts

@@ -12,8 +12,29 @@
  * governing permissions and limitations under the License.
  */
 
+import { HTTP_OK } from "@adobe/aio-commerce-lib-api/utils";
 import { SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
 
+//#region source/responses/helpers.d.ts
+/**
+ * Determines whether a webhook action's result represents a successful outcome.
+ * Adobe Commerce webhooks always respond with HTTP 200, even when the handler
+ * wants to block the triggering process, so the actual outcome is only visible
+ * in the response body's `op` field (`op: "exception"` signals a failure).
+ *
+ * @param result - The result of the instrumented webhook action.
+ * @returns True if the webhook response is successful, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isWebhookSuccessful } from "@adobe/aio-commerce-lib-webhooks/responses";
+ *
+ * const result = await runWebhookAction(params);
+ * span.setStatus(isWebhookSuccessful(result) ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR });
+ * ```
+ */
+declare function isWebhookSuccessful(result: unknown): boolean;
+//#endregion
 //#region source/responses/operations/types.d.ts
 /**
  * Success operation response
@@ -172,4 +193,20 @@ declare const removeOperation: (path: string) => RemoveOperation;
  */
 declare function ok<TValue = unknown>(operations: WebhookOperationResponse<TValue> | WebhookOperationResponse[]): SuccessResponse;
 //#endregion
-export { type AddOperation, type ExceptionOperation, type RemoveOperation, type ReplaceOperation, type SuccessOperation, type WebhookOperationResponse, addOperation, exceptionOperation, ok, removeOperation, replaceOperation, successOperation };
+//#region source/responses/types.d.ts
+/**
+ * Successful SDK response containing webhook operation response body data.
+ */
+type WebhookSuccessResponse = Omit<SuccessResponse, "body" | "statusCode"> & {
+  body?: WebhookOperationResponse | WebhookOperationResponse[];
+  statusCode: typeof HTTP_OK;
+};
+/**
+ * Determines whether a value is a successful SDK response containing webhook operation response body data.
+ *
+ * @param response - Value to inspect.
+ * @returns True when the value matches the webhook success response shape.
+ */
+declare function isWebhookSuccessResponse(response: unknown): response is WebhookSuccessResponse;
+//#endregion
+export { type AddOperation, type ExceptionOperation, type RemoveOperation, type ReplaceOperation, type SuccessOperation, type WebhookOperationResponse, type WebhookSuccessResponse, addOperation, exceptionOperation, isWebhookSuccessResponse, isWebhookSuccessful, ok, removeOperation, replaceOperation, successOperation };

package/dist/es/responses/index.mjs

@@ -12,8 +12,78 @@
  * governing permissions and limitations under the License.
  */
 
+import { HTTP_OK } from "@adobe/aio-commerce-lib-api/utils";
 import { ok as ok$1 } from "@adobe/aio-commerce-lib-core/responses";
 
+//#region source/responses/operations/types.ts
+function isRecord$1(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+* Determines whether a value is a webhook operation response.
+*
+* @param body - Value to inspect.
+* @returns True when the value matches one of the webhook operation response shapes.
+*/
+function isWebhookOperationResponse(body) {
+	if (!isRecord$1(body)) return false;
+	const { op, path } = body;
+	if (op === "success" || op === "exception") return true;
+	if (op === "add" || op === "replace") return typeof path === "string" && "value" in body;
+	return op === "remove" && typeof path === "string";
+}
+/**
+* Determines whether a value is an array of webhook operation responses.
+*
+* @param body - Value to inspect.
+* @returns True when every array item matches a webhook operation response shape.
+*/
+function isWebhookOperationResponseArray(body) {
+	return Array.isArray(body) && body.every(isWebhookOperationResponse);
+}
+
+//#endregion
+//#region source/responses/types.ts
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+* Determines whether a value is a successful SDK response containing webhook operation response body data.
+*
+* @param response - Value to inspect.
+* @returns True when the value matches the webhook success response shape.
+*/
+function isWebhookSuccessResponse(response) {
+	return isRecord(response) && response.type === "success" && response.statusCode === HTTP_OK && (response.body === void 0 || isWebhookOperationResponse(response.body) || isWebhookOperationResponseArray(response.body));
+}
+
+//#endregion
+//#region source/responses/helpers.ts
+/**
+* Determines whether a webhook action's result represents a successful outcome.
+* Adobe Commerce webhooks always respond with HTTP 200, even when the handler
+* wants to block the triggering process, so the actual outcome is only visible
+* in the response body's `op` field (`op: "exception"` signals a failure).
+*
+* @param result - The result of the instrumented webhook action.
+* @returns True if the webhook response is successful, false otherwise.
+*
+* @example
+* ```typescript
+* import { isWebhookSuccessful } from "@adobe/aio-commerce-lib-webhooks/responses";
+*
+* const result = await runWebhookAction(params);
+* span.setStatus(isWebhookSuccessful(result) ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR });
+* ```
+*/
+function isWebhookSuccessful(result) {
+	if (!isWebhookSuccessResponse(result)) return false;
+	if (!result.body) return true;
+	if (Array.isArray(result.body)) return result.body.every((operation) => operation.op !== "exception");
+	return result.body.op !== "exception";
+}
+
+//#endregion
 //#region source/responses/operations/presets.ts
 /**
 * Creates a success operation response
@@ -139,4 +209,4 @@ function ok(operations) {
 }
 
 //#endregion
-export { addOperation, exceptionOperation, ok, removeOperation, replaceOperation, successOperation };
+export { addOperation, exceptionOperation, isWebhookSuccessResponse, isWebhookSuccessful, ok, removeOperation, replaceOperation, successOperation };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@adobe/aio-commerce-lib-webhooks",
   "type": "module",
   "author": "Adobe Inc.",
-  "version": "1.1.2",
+  "version": "1.2.0-beta-20260714082406",
   "private": false,
   "engines": {
     "node": ">=22 <=24"
@@ -64,8 +64,8 @@
   "dependencies": {
     "ky": "^1.9.0",
     "valibot": "^1.1.0",
-    "@adobe/aio-commerce-lib-api": "1.2.1",
-    "@adobe/aio-commerce-lib-core": "1.1.1"
+    "@adobe/aio-commerce-lib-api": "1.3.0-beta-20260714082406",
+    "@adobe/aio-commerce-lib-core": "1.2.0-beta-20260714082406"
   },
   "devDependencies": {
     "typescript": "^6.0.0",
@@ -73,7 +73,7 @@
     "@aio-commerce-sdk/config-tsdown": "1.0.1",
     "@aio-commerce-sdk/config-typescript": "1.0.0",
     "@aio-commerce-sdk/config-vitest": "1.0.0",
-    "@aio-commerce-sdk/scripting-utils": "0.3.3",
+    "@aio-commerce-sdk/scripting-utils": "0.3.4-beta-20260714082406",
     "@aio-commerce-sdk/scripts": "0.1.0"
   },
   "sideEffects": false,