Merge pull request #6549 from Shopify/rz-add-webhook-actions

Add support for webhook actions attribute

Author: rzaharenkov

packages/app/src/cli/models/app/loader.test.ts

@@ -3303,6 +3303,22 @@ describe('WebhooksSchema', () => {
     expect(parsedConfiguration.webhooks).toMatchObject(webhookConfig)
   })
 
+  test('accepts webhook subscription with actions', async () => {
+    const webhookConfig: WebhooksConfig = {
+      api_version: '2024-01',
+      subscriptions: [
+        {
+          topics: ['products/create'],
+          uri: 'https://example.com/webhooks',
+          actions: ['create'],
+        },
+      ],
+    }
+    const {abortOrReport, parsedConfiguration} = await setupParsing({}, webhookConfig)
+    expect(abortOrReport).not.toHaveBeenCalled()
+    expect(parsedConfiguration.webhooks).toMatchObject(webhookConfig)
+  })
+
   async function setupParsing(errorObj: zod.ZodIssue | {}, webhookConfigOverrides: WebhooksConfig) {
     const err = Array.isArray(errorObj) ? errorObj : [errorObj]
     const expectedFormatted = outputContent`\n${outputToken.errorText(

packages/app/src/cli/models/extensions/specifications/app_config_webhook_schemas/webhook_subscription_schema.ts

@@ -13,6 +13,7 @@ export const WebhookSubscriptionSchema = zod.object({
       invalid_type_error: 'Value must be string[]',
     })
     .optional(),
+  actions: zod.array(zod.string({invalid_type_error: 'Value must be a string'})).optional(),
   uri: zod.preprocess((arg) => removeTrailingSlash(arg as string), WebhookSubscriptionUriValidation, {
     required_error: 'Missing value at',
   }),

packages/app/src/cli/models/extensions/specifications/app_config_webhook_subscription.ts

@@ -11,6 +11,7 @@ interface TransformedWebhookSubscription {
   api_version: string
   uri: string
   topic: string
+  actions: string[]
   compliance_topics?: string[]
   include_fields?: string[]
   filter?: string
@@ -19,6 +20,7 @@ interface TransformedWebhookSubscription {
 
 export const SingleWebhookSubscriptionSchema = zod.object({
   topic: zod.string(),
+  actions: zod.array(zod.string({invalid_type_error: 'Value must be a string'})).optional(),
   api_version: zod.string(),
   uri: zod.preprocess(removeTrailingSlash as (arg: unknown) => unknown, WebhookSubscriptionUriValidation, {
     required_error: 'Missing value at',

packages/app/src/cli/models/extensions/specifications/types/app_config_webhook.ts

@@ -1,6 +1,7 @@
 export interface WebhookSubscription {
   uri: string
   topics?: string[]
+  actions?: string[]
   compliance_topics?: string[]
   include_fields?: string[]
   filter?: string