Merge pull request #6576 from Shopify/add-webhook-name-field

added a name field to webhook subscriptions

Author: georgge293

.changeset/spotty-buckets-join.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': minor
+---
+
+Add support for an optional name field for webhook subscriptions in shopify.app.toml

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

@@ -3441,6 +3441,22 @@ describe('WebhooksSchema', () => {
     expect(parsedConfiguration.webhooks).toMatchObject(webhookConfig)
   })
 
+  test('accepts webhook subscription with name', async () => {
+    const webhookConfig: WebhooksConfig = {
+      api_version: '2024-01',
+      subscriptions: [
+        {
+          topics: ['products/create'],
+          uri: 'https://example.com/webhooks',
+          name: 'products/create',
+        },
+      ],
+    }
+    const {abortOrReport, parsedConfiguration} = await setupParsing({}, webhookConfig)
+    expect(abortOrReport).not.toHaveBeenCalled()
+    expect(parsedConfiguration.webhooks).toMatchObject(webhookConfig)
+  })
+
   test('accepts webhook subscription with actions', async () => {
     const webhookConfig: WebhooksConfig = {
       api_version: '2024-01',

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

@@ -20,6 +20,7 @@ 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(),
   payload_query: zod.string({invalid_type_error: 'Value must be a string'}).trim().min(1).optional(),
+  name: zod.string({invalid_type_error: 'Value must be a string'}).trim().min(1).max(50).optional(),
 
   compliance_topics: zod
     .array(

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

@@ -16,6 +16,7 @@ interface TransformedWebhookSubscription {
   include_fields?: string[]
   filter?: string
   payload_query?: string
+  name?: string
 }
 
 export const SingleWebhookSubscriptionSchema = zod.object({
@@ -28,6 +29,7 @@ export const SingleWebhookSubscriptionSchema = 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(),
   payload_query: zod.string({invalid_type_error: 'Value must be a string'}).trim().min(1).optional(),
+  name: zod.string({invalid_type_error: 'Value must be a string'}).min(1).max(50).optional(),
 })
 
 /* this transforms webhooks remotely to be accepted by the TOML

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

@@ -6,6 +6,7 @@ export interface WebhookSubscription {
   include_fields?: string[]
   filter?: string
   payload_query?: string
+  name?: string
 }
 
 interface PrivacyComplianceConfig {