Add support for Metafields to webhooks

Shopify · Jan 7, 2025 · f3135a3 · f3135a3
1 parent 30464f0
commit f3135a3
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/packages/app/src/cli/models/app/app.test-data.ts b/packages/app/src/cli/models/app/app.test-data.ts
@@ -426,6 +426,7 @@ export async function testSingleWebhookSubscriptionExtension({
     topic,
     api_version: '2024-01',
     uri: 'https://my-app.com/webhooks',
+    metafields: [{namespace: 'custom', key: 'test'}],
   },
 }: {
   emptyConfig?: boolean

diff --git a/packages/app/src/cli/models/extensions/specifications/app_config_webhook.test.ts b/packages/app/src/cli/models/extensions/specifications/app_config_webhook.test.ts
@@ -13,10 +13,12 @@ describe('webhooks', () => {
             {
               topics: ['orders/create'],
               uri: 'https://example.com/webhooks/orders',
+              metafields: [{namespace: 'custom', key: 'test'}],
             },
             {
               topics: ['products/create'],
               uri: 'https://example.com/webhooks/products',
+              metafields: [{namespace: 'custom', key: 'test'}],
             },
           ],
         },
@@ -41,10 +43,12 @@ describe('webhooks', () => {
           {
             topic: 'orders/create',
             uri: 'https://example.com/webhooks/orders',
+            metafields: [{namespace: 'custom', key: 'test'}],
           },
           {
             topic: 'products/create',
             uri: 'https://example.com/webhooks/products',
+            metafields: [{namespace: 'custom', key: 'test'}],
           },
         ],
       }

diff --git a/...odels/extensions/specifications/app_config_webhook_schemas/webhook_subscription_schema.ts b/...odels/extensions/specifications/app_config_webhook_schemas/webhook_subscription_schema.ts
@@ -18,6 +18,15 @@ export const WebhookSubscriptionSchema = zod.object({
   }),
   include_fields: zod.array(zod.string({invalid_type_error: 'Value must be a string'})).optional(),
   filter: zod.string({invalid_type_error: 'Value must be a string'}).optional(),
+  metafields: zod
+    .array(
+      zod.object({
+        namespace: zod.string({invalid_type_error: 'Metafield namespace must be a string'}),
+        key: zod.string({invalid_type_error: 'Metafield key must be a string'}),
+      }),
+      {invalid_type_error: 'Metafields must be an array of objects with namespace and key'},
+    )
+    .optional(),
   compliance_topics: zod
     .array(
       zod.enum([ComplianceTopic.CustomersRedact, ComplianceTopic.CustomersDataRequest, ComplianceTopic.ShopRedact]),

diff --git a/packages/app/src/cli/models/extensions/specifications/types/app_config_webhook.ts b/packages/app/src/cli/models/extensions/specifications/types/app_config_webhook.ts
@@ -4,6 +4,10 @@ export interface WebhookSubscription {
   compliance_topics?: string[]
   include_fields?: string[]
   filter?: string
+  metafields?: {
+    namespace: string
+    key: string
+  }[]
 }
 
 interface PrivacyComplianceConfig {