fix(webhooks): subscription recreation path

Author: icecrasher321

apps/sim/app/api/webhooks/[id]/route.ts

@@ -13,6 +13,7 @@ import {
   createExternalWebhookSubscription,
   shouldRecreateExternalWebhookSubscription,
 } from '@/lib/webhooks/provider-subscriptions'
+import { mergeNonUserFields } from '@/lib/webhooks/utils'
 import { getUserEntityPermissions } from '@/lib/workspaces/permissions/utils'
 
 const logger = createLogger('WebhookAPI')
@@ -185,21 +186,22 @@ export async function PATCH(request: NextRequest, { params }: { params: Promise<
 
     const existingProviderConfig =
       (webhookData.webhook.providerConfig as Record<string, unknown>) || {}
+    const nextProvider = (provider ?? webhookData.webhook.provider) as string
+
     let nextProviderConfig =
       providerConfig !== undefined &&
       resolvedProviderConfig &&
       typeof resolvedProviderConfig === 'object'
         ? (resolvedProviderConfig as Record<string, unknown>)
         : existingProviderConfig
-    const nextProvider = (provider ?? webhookData.webhook.provider) as string
 
     if (
       providerConfig !== undefined &&
       shouldRecreateExternalWebhookSubscription({
         previousProvider: webhookData.webhook.provider as string,
         nextProvider,
         previousConfig: existingProviderConfig,
-        nextConfig: nextProviderConfig,
+        nextConfig: originalProviderConfig as Record<string, unknown>,
       })
     ) {
       await cleanupExternalWebhook(
@@ -231,24 +233,13 @@ export async function PATCH(request: NextRequest, { params }: { params: Promise<
       hasFailedCountUpdate: failedCount !== undefined,
     })
 
-    let finalProviderConfig = webhooks[0].webhook.providerConfig
+    let finalProviderConfig: Record<string, unknown> =
+      (webhooks[0].webhook.providerConfig as Record<string, unknown>) || {}
     if (providerConfig !== undefined && originalProviderConfig) {
-      const existingConfig = existingProviderConfig
-      finalProviderConfig = {
-        ...originalProviderConfig,
-        credentialId: existingConfig.credentialId,
-        credentialSetId: existingConfig.credentialSetId,
-        userId: existingConfig.userId,
-        historyId: existingConfig.historyId,
-        lastCheckedTimestamp: existingConfig.lastCheckedTimestamp,
-        setupCompleted: existingConfig.setupCompleted,
-        externalId: existingConfig.externalId,
-      }
-      for (const [key, value] of Object.entries(nextProviderConfig)) {
-        if (!(key in originalProviderConfig)) {
-          ;(finalProviderConfig as Record<string, unknown>)[key] = value
-        }
-      }
+      const userProvided = originalProviderConfig as Record<string, unknown>
+      finalProviderConfig = { ...userProvided }
+      mergeNonUserFields(finalProviderConfig, existingProviderConfig, userProvided)
+      mergeNonUserFields(finalProviderConfig, nextProviderConfig, userProvided)
     }
 
     const updatedWebhook = await db

apps/sim/app/api/webhooks/route.ts

@@ -9,6 +9,7 @@ import { PlatformEvents } from '@/lib/core/telemetry'
 import { generateRequestId } from '@/lib/core/utils/request'
 import { resolveEnvVarsInObject } from '@/lib/webhooks/env-resolver'
 import { createExternalWebhookSubscription } from '@/lib/webhooks/provider-subscriptions'
+import { mergeNonUserFields } from '@/lib/webhooks/utils'
 import { getUserEntityPermissions } from '@/lib/workspaces/permissions/utils'
 
 const logger = createLogger('WebhooksAPI')
@@ -466,7 +467,8 @@ export async function POST(request: NextRequest) {
       providerConfig: providerConfigOverride,
     })
 
-    const configToSave = { ...originalProviderConfig }
+    const userProvided = originalProviderConfig as Record<string, unknown>
+    const configToSave: Record<string, unknown> = { ...userProvided }
 
     try {
       const result = await createExternalWebhookSubscription(
@@ -477,11 +479,7 @@ export async function POST(request: NextRequest) {
         requestId
       )
       const updatedConfig = result.updatedProviderConfig as Record<string, unknown>
-      for (const [key, value] of Object.entries(updatedConfig)) {
-        if (!(key in originalProviderConfig)) {
-          configToSave[key] = value
-        }
-      }
+      mergeNonUserFields(configToSave, updatedConfig, userProvided)
       resolvedProviderConfig = updatedConfig
       externalSubscriptionCreated = result.externalSubscriptionCreated
     } catch (err) {

apps/sim/lib/webhooks/utils.ts

@@ -1,5 +1,5 @@
 /**
- * Pure utility functions for TwiML processing
+ * Pure utility functions for webhook processing
  * This file has NO server-side dependencies to ensure it can be safely imported in client-side code
  */
 
@@ -18,3 +18,19 @@ export function convertSquareBracketsToTwiML(twiml: string | undefined): string
   // Replace [Tag] with <Tag> and [/Tag] with </Tag>
   return twiml.replace(/\[(\/?[^\]]+)\]/g, '<$1>')
 }
+
+/**
+ * Merges fields from source into target, but only if they don't exist in the base config.
+ * Used to preserve system-managed fields while respecting user-provided values.
+ */
+export function mergeNonUserFields(
+  target: Record<string, unknown>,
+  source: Record<string, unknown>,
+  userProvided: Record<string, unknown>
+): void {
+  for (const [key, value] of Object.entries(source)) {
+    if (!(key in userProvided)) {
+      target[key] = value
+    }
+  }
+}