add generic webhook test event verification subblock

Author: icecrasher321

apps/sim/lib/webhooks/deploy.ts

@@ -602,6 +602,7 @@ export async function saveTriggerWebhooksForDeploy({
         provider,
         workflowId,
         blockId: block.id,
+        metadata: providerConfig,
       })
 
       const result = await createExternalWebhookSubscription(

apps/sim/lib/webhooks/pending-verification.test.ts

@@ -72,6 +72,44 @@ describe('pending webhook verification', () => {
     ).toBe(false)
   })
 
+  it('does not register generic pending verification unless verifyTestEvents is enabled', async () => {
+    await registerPendingWebhookVerification({
+      path: 'grain-path-3',
+      provider: 'generic',
+      metadata: { verifyTestEvents: false },
+    })
+
+    expect(await getPendingWebhookVerification('grain-path-3')).toBeNull()
+  })
+
+  it('registers generic pending verification when verifyTestEvents is enabled', async () => {
+    await registerPendingWebhookVerification({
+      path: 'grain-path-3',
+      provider: 'generic',
+      metadata: { verifyTestEvents: true },
+    })
+
+    const entry = await getPendingWebhookVerification('grain-path-3')
+
+    expect(entry).toMatchObject({
+      path: 'grain-path-3',
+      provider: 'generic',
+      metadata: { verifyTestEvents: true },
+    })
+    expect(
+      matchesPendingWebhookVerificationProbe(entry!, {
+        method: 'POST',
+        body: {},
+      })
+    ).toBe(true)
+    expect(
+      matchesPendingWebhookVerificationProbe(entry!, {
+        method: 'POST',
+        body: { message: 'real event' },
+      })
+    ).toBe(false)
+  })
+
   it('clears tracked pending verifications after a successful lifecycle', async () => {
     const tracker = new PendingWebhookVerificationTracker()
 

apps/sim/lib/webhooks/pending-verification.ts

@@ -31,11 +31,23 @@ interface PendingWebhookVerificationProbe {
   body: Record<string, unknown> | undefined
 }
 
+type PendingWebhookVerificationRegistrationMatcher = (
+  registration: PendingWebhookVerificationRegistration
+) => boolean
+
 type PendingWebhookVerificationProbeMatcher = (
   probe: PendingWebhookVerificationProbe,
   entry: PendingWebhookVerification
 ) => boolean
 
+const pendingWebhookVerificationRegistrationMatchers: Record<
+  string,
+  PendingWebhookVerificationRegistrationMatcher
+> = {
+  grain: () => true,
+  generic: (registration) => registration.metadata?.verifyTestEvents === true,
+}
+
 const pendingWebhookVerificationProbeMatchers: Record<
   string,
   PendingWebhookVerificationProbeMatcher
@@ -44,6 +56,10 @@ const pendingWebhookVerificationProbeMatchers: Record<
     method === 'GET' ||
     method === 'HEAD' ||
     (method === 'POST' && (!body || Object.keys(body).length === 0 || !body.type)),
+  generic: ({ method, body }) =>
+    method === 'GET' ||
+    method === 'HEAD' ||
+    (method === 'POST' && (!body || Object.keys(body).length === 0)),
 }
 
 function getRedisKey(path: string): string {
@@ -68,14 +84,27 @@ function getInMemoryPendingWebhookVerification(path: string): PendingWebhookVeri
   return entry
 }
 
-export function requiresPendingWebhookVerification(provider: string): boolean {
-  return provider in pendingWebhookVerificationProbeMatchers
+export function requiresPendingWebhookVerification(
+  provider: string,
+  metadata?: Record<string, unknown>
+): boolean {
+  const registrationMatcher = pendingWebhookVerificationRegistrationMatchers[provider]
+  if (!registrationMatcher) {
+    return false
+  }
+
+  return registrationMatcher({
+    path: '',
+    provider,
+    metadata,
+  })
 }
 
 export async function registerPendingWebhookVerification(
   registration: PendingWebhookVerificationRegistration
 ): Promise<void> {
-  if (!requiresPendingWebhookVerification(registration.provider)) {
+  const registrationMatcher = pendingWebhookVerificationRegistrationMatchers[registration.provider]
+  if (!registrationMatcher || !registrationMatcher(registration)) {
     return
   }
 
@@ -160,7 +189,9 @@ export class PendingWebhookVerificationTracker {
   private readonly registeredPaths = new Set<string>()
 
   async register(registration: PendingWebhookVerificationRegistration): Promise<void> {
-    if (!requiresPendingWebhookVerification(registration.provider)) {
+    const registrationMatcher =
+      pendingWebhookVerificationRegistrationMatchers[registration.provider]
+    if (!registrationMatcher || !registrationMatcher(registration)) {
       return
     }
 

apps/sim/lib/webhooks/provider-subscriptions.ts

@@ -1343,15 +1343,29 @@ export async function createGrainWebhookSubscription(
       throw new Error(userFriendlyMessage)
     }
 
+    const grainWebhookId = responseBody.id
+
+    if (!grainWebhookId) {
+      grainLogger.error(
+        `[${requestId}] Grain webhook creation response missing id for webhook ${webhookData.id}.`,
+        {
+          response: responseBody,
+        }
+      )
+      throw new Error(
+        'Grain webhook created but no webhook ID was returned in the response. Cannot track subscription.'
+      )
+    }
+
     grainLogger.info(
       `[${requestId}] Successfully created webhook in Grain for webhook ${webhookData.id}.`,
       {
-        grainWebhookId: responseBody.id ?? responseBody.hook?.id,
+        grainWebhookId,
         eventTypes,
       }
     )
 
-    return { id: responseBody.id ?? responseBody.hook?.id, eventTypes }
+    return { id: grainWebhookId, eventTypes }
   } catch (error: any) {
     grainLogger.error(
       `[${requestId}] Exception during Grain webhook creation for webhook ${webhookData.id}.`,

apps/sim/tools/grain/create_hook.ts

@@ -65,9 +65,13 @@ export const grainCreateHookTool: ToolConfig<GrainCreateHookParams, GrainCreateH
       throw new Error(data.error || data.message || 'Failed to create webhook')
     }
 
+    if (!data?.id) {
+      throw new Error('Grain webhook created but response did not include a webhook id')
+    }
+
     return {
       success: true,
-      output: data.hook || data,
+      output: data,
     }
   },
 

apps/sim/triggers/generic/webhook.ts

@@ -70,6 +70,15 @@ export const genericWebhookTrigger: TriggerConfig = {
       defaultValue: 'default',
       mode: 'trigger',
     },
+    {
+      id: 'verifyTestEvents',
+      title: 'Verify Test Events',
+      type: 'switch',
+      description:
+        'Return a temporary 200 response for test or verification probes on this webhook URL during setup.',
+      defaultValue: false,
+      mode: 'trigger',
+    },
     {
       id: 'responseStatusCode',
       title: 'Response Status Code',
@@ -120,6 +129,7 @@ export const genericWebhookTrigger: TriggerConfig = {
         'All request data (headers, body, query parameters) will be available in your workflow.',
         'If authentication is enabled, include the token in requests using either the custom header or "Authorization: Bearer TOKEN".',
         'To deduplicate incoming events, set the Deduplication Field to the dot-notation path of a unique identifier in the payload (e.g. "event.id"). Duplicate values within 7 days will be skipped.',
+        'Enable "Verify Test Events" only if the sending service needs a temporary 200 response while validating the webhook URL.',
       ]
         .map(
           (instruction, index) =>