Return webhook registration operation

.changeset/sour-crabs-brush.md

@@ -0,0 +1,5 @@
+---
+'@shopify/shopify-api': patch
+---
+
+Return the performed operation for each handler when registering webhooks

docs/reference/webhooks/register.md

@@ -53,12 +53,24 @@ Returns an object containing a list of results, indexed by topic. Each entry in
 
 Whether the registration was successful.
 
+### deliveryMethod
+
+`string`
+
+The configured delivery method for the registered webhook.
+
 ### result
 
 `array`
 
 The body from the Shopify request to register the webhook.
 
+### operation
+
+`WebhookOperation`
+
+Which operation was performed to obtain this result.
+
 > **Note**: This object will only contain results for a handler if any of its information was updated with Shopify.
 
 [Back to shopify.webhooks](./README.md)

lib/webhooks/__tests__/register.test.ts

@@ -1,9 +1,18 @@
 import {Method, Header} from '@shopify/network';
 
-import {RegisterParams, RegisterReturn, WebhookHandler} from '../types';
+import {
+  RegisterParams,
+  RegisterReturn,
+  WebhookHandler,
+  WebhookOperation,
+} from '../types';
 import {gdprTopics, ShopifyHeader} from '../../types';
 import {DataType} from '../../clients/types';
-import {queueMockResponse, shopify} from '../../__tests__/test-helper';
+import {
+  queueMockResponse,
+  queueMockResponses,
+  shopify,
+} from '../../__tests__/test-helper';
 import {mockTestRequests} from '../../../adapters/mock/mock_test_requests';
 import {queryTemplate} from '../query-template';
 import {TEMPLATE_GET_HANDLERS, TEMPLATE_MUTATION} from '../register';
@@ -357,6 +366,34 @@ describe('shopify.webhooks.register', () => {
     );
     assertRegisterResponse({registerReturn, topic, responses});
   });
+
+  it('returns which operation was done for each handler', async () => {
+    shopify.webhooks.addHandlers({
+      PRODUCTS_UPDATE: {...HTTP_HANDLER, includeFields: ['id', 'title']},
+    });
+    shopify.webhooks.addHandlers({
+      PRODUCTS_DELETE: HTTP_HANDLER,
+    });
+
+    queueMockResponses(
+      [JSON.stringify(mockResponses.webhookCheckMultiHandlerResponse)],
+      [JSON.stringify(mockResponses.successResponse)],
+      [JSON.stringify(mockResponses.successUpdateResponse)],
+      [JSON.stringify(mockResponses.successDeleteResponse)],
+    );
+
+    const registerReturn = await shopify.webhooks.register({session});
+
+    expect(registerReturn.PRODUCTS_CREATE[0].operation).toEqual(
+      WebhookOperation.Delete,
+    );
+    expect(registerReturn.PRODUCTS_DELETE[0].operation).toEqual(
+      WebhookOperation.Create,
+    );
+    expect(registerReturn.PRODUCTS_UPDATE[0].operation).toEqual(
+      WebhookOperation.Update,
+    );
+  });
 });
 
 async function registerWebhook({

lib/webhooks/register.ts

@@ -367,13 +367,15 @@ async function runMutation({
       deliveryMethod: handler.deliveryMethod,
       success: isSuccess(result.body, handler, operation),
       result: result.body,
+      operation,
     };
   } catch (error) {
     if (error instanceof InvalidDeliveryMethodError) {
       registerResult = {
         deliveryMethod: handler.deliveryMethod,
         success: false,
         result: {message: error.message},
+        operation,
       };
     } else {
       throw error;

lib/webhooks/types.ts

@@ -69,6 +69,7 @@ export interface RegisterResult {
   success: boolean;
   deliveryMethod: DeliveryMethod;
   result: unknown;
+  operation: WebhookOperation;
 }
 
 export interface RegisterReturn {