Reject webhook/schedule flows on prediction API and surface trigger-specific code samples (#6361)

* guard prediction API against webhook/schedule trigger flows and surface trigger-specific API snippets

* Enhance error message for webhook trigger configuration in executeAgentFlow function to include the configured HTTP method

Author: HenryHengZJ

packages/server/src/Interface.ts

@@ -189,6 +189,8 @@ export interface IExecution {
 
 export type ScheduleInputMode = 'text' | 'form' | 'none'
 
+export type StartInputType = 'chatInput' | 'formInput' | 'webhookTrigger' | 'scheduleInput'
+
 export interface IScheduleRecord {
     id: string
     triggerType: string

packages/server/src/controllers/webhook-listener/index.ts

@@ -3,7 +3,7 @@ import { StatusCodes } from 'http-status-codes'
 import { InternalFlowiseError } from '../../errors/internalFlowiseError'
 import { getRunningExpressApp } from '../../utils/getRunningExpressApp'
 import { getWebhookListenerRegistry } from '../../services/webhook-listener'
-import { IReactFlowObject } from '../../Interface'
+import { IReactFlowObject, StartInputType } from '../../Interface'
 import chatflowsService from '../../services/chatflows'
 import logger from '../../utils/logger'
 
@@ -16,7 +16,8 @@ const assertChatflowIsWebhookTriggered = async (chatflowid: string, workspaceId?
     }
     const parsedFlowData: IReactFlowObject = JSON.parse(chatflow.flowData)
     const startNode = parsedFlowData.nodes.find((node) => node.data.name === 'startAgentflow')
-    if (startNode?.data?.inputs?.startInputType !== 'webhookTrigger') {
+    const startInputType = startNode?.data?.inputs?.startInputType as StartInputType | undefined
+    if (startInputType !== 'webhookTrigger') {
         throw new InternalFlowiseError(StatusCodes.BAD_REQUEST, `Chatflow ${chatflowid} is not configured as a webhook trigger`)
     }
 }

packages/server/src/services/chatflows/index.ts

@@ -3,7 +3,7 @@ import { ICommonObject, removeFolderFromStorage } from 'flowise-components'
 import { StatusCodes } from 'http-status-codes'
 import { Brackets, In, QueryRunner } from 'typeorm'
 import { validate as isValidUUID } from 'uuid'
-import { ChatflowType, IReactFlowObject, ScheduleInputMode } from '../../Interface'
+import { ChatflowType, IReactFlowObject, ScheduleInputMode, StartInputType } from '../../Interface'
 import { FLOWISE_COUNTER_STATUS, FLOWISE_METRIC_COUNTERS } from '../../Interface.Metrics'
 import { UsageCacheManager } from '../../UsageCacheManager'
 import { ChatFlow, EnumChatflowType } from '../../database/entities/ChatFlow'
@@ -381,7 +381,7 @@ const saveChatflow = async (
         const parsedFlowData: IReactFlowObject = JSON.parse(flowData)
         const nodes = (parsedFlowData.nodes || []).filter((node) => node.data.name !== 'stickyNoteAgentflow')
         const startNode = nodes.find((node) => node.data.name === 'startAgentflow')
-        const startInputType = startNode?.data?.inputs?.startInputType as 'chatInput' | 'formInput' | 'scheduleInput'
+        const startInputType = startNode?.data?.inputs?.startInputType as StartInputType | undefined
         if (startInputType === 'scheduleInput') {
             const scheduleInputMode = startNode?.data?.inputs?.scheduleInputMode as ScheduleInputMode | undefined
             if (!scheduleInputMode) {
@@ -493,7 +493,7 @@ const updateChatflow = async (
         const parsedFlowData: IReactFlowObject = JSON.parse(flowData)
         const nodes = (parsedFlowData.nodes || []).filter((node) => node.data.name !== 'stickyNoteAgentflow')
         const startNode = nodes.find((node) => node.data.name === 'startAgentflow')
-        const startInputType = startNode?.data?.inputs?.startInputType as 'chatInput' | 'formInput' | 'scheduleInput'
+        const startInputType = startNode?.data?.inputs?.startInputType as StartInputType | undefined
         if (startInputType === 'scheduleInput') {
             const scheduleInputMode = startNode?.data?.inputs?.scheduleInputMode as ScheduleInputMode | undefined
             if (!scheduleInputMode) {

packages/server/src/services/mcp-endpoint/index.ts

@@ -11,7 +11,7 @@ import { createMockRequest } from '../../utils/mockRequest'
 import mcpServerService from '../mcp-server/index'
 import { ChatFlow } from '../../database/entities/ChatFlow'
 import logger from '../../utils/logger'
-import { ChatType, IMcpServerConfig, IReactFlowObject } from '../../Interface'
+import { ChatType, IMcpServerConfig, IReactFlowObject, StartInputType } from '../../Interface'
 
 /**
  * Build the MCP tool name from config + chatflow
@@ -49,7 +49,7 @@ function getToolInputType(chatflow: ChatFlow): 'question' | 'form' {
             const flowData: IReactFlowObject = JSON.parse(chatflow.flowData)
             const nodes = flowData.nodes || []
             const startNode = nodes.find((node) => node.data.name === 'startAgentflow')
-            const startInputType = startNode?.data?.inputs?.startInputType as 'chatInput' | 'formInput'
+            const startInputType = startNode?.data?.inputs?.startInputType as StartInputType | undefined
             return startInputType === 'formInput' ? 'form' : 'question'
         } catch (error) {
             logger.error(`Failed to parse flowData for chatflow ${chatflow.id}: ${getErrorMessage(error)}`)

packages/server/src/services/schedule/index.ts

@@ -19,7 +19,7 @@ import {
     canScheduleEnable
 } from './utils'
 import { ICommonObject } from 'flowise-components'
-import { ScheduleInputMode } from '../../Interface'
+import { ScheduleInputMode, StartInputType } from '../../Interface'
 
 export {
     validateCronExpression,
@@ -220,7 +220,8 @@ const getScheduleStatus = async (
         try {
             const parsedFlowData = JSON.parse(chatflow.flowData)
             const startNode = (parsedFlowData.nodes || []).find((n: any) => n.data?.name === 'startAgentflow')
-            if (!startNode || startNode.data?.inputs?.startInputType !== 'scheduleInput') {
+            const startInputType = startNode?.data?.inputs?.startInputType as StartInputType | undefined
+            if (!startNode || startInputType !== 'scheduleInput') {
                 return { record, canEnable: false, reason: 'Flow is not configured as a scheduled flow' }
             }
 

packages/server/src/services/webhook/index.ts

@@ -1,5 +1,5 @@
 import { StatusCodes } from 'http-status-codes'
-import { IReactFlowObject } from '../../Interface'
+import { IReactFlowObject, StartInputType } from '../../Interface'
 import { InternalFlowiseError } from '../../errors/internalFlowiseError'
 import { getErrorMessage } from '../../errors/utils'
 import { verifyWebhookSignature, verifyPlainToken } from '../../utils/signatureVerification'
@@ -23,7 +23,7 @@ const validateWebhookChatflow = async (
 
         const parsedFlowData: IReactFlowObject = JSON.parse(chatflow.flowData)
         const startNode = parsedFlowData.nodes.find((node) => node.data.name === 'startAgentflow')
-        const startInputType = startNode?.data?.inputs?.startInputType
+        const startInputType = startNode?.data?.inputs?.startInputType as StartInputType | undefined
 
         if (startInputType !== 'webhookTrigger') {
             throw new InternalFlowiseError(StatusCodes.NOT_FOUND, `Chatflow ${chatflowId} is not configured as a webhook trigger`)

packages/server/src/utils/buildAgentflow.ts

@@ -30,7 +30,8 @@ import {
     IComponentNodes,
     INodeOverrides,
     IVariableOverride,
-    INodeDirectedGraph
+    INodeDirectedGraph,
+    StartInputType
 } from '../Interface'
 import {
     RUNTIME_MESSAGES_LENGTH_VAR_PREFIX,
@@ -60,6 +61,8 @@ import { Telemetry } from './telemetry'
 import { getWorkspaceSearchOptions } from '../enterprise/utils/ControllerServiceUtils'
 import { UsageCacheManager } from '../UsageCacheManager'
 import { generateTTSForResponseStream, shouldAutoPlayTTS } from './buildChatflow'
+import { InternalFlowiseError } from '../errors/internalFlowiseError'
+import { StatusCodes } from 'http-status-codes'
 
 interface IWaitingNode {
     nodeId: string
@@ -1592,10 +1595,26 @@ export const executeAgentFlow = async ({
     const { graph, nodeDependencies } = constructGraphs(nodes, edges)
     const { graph: reversedGraph } = constructGraphs(nodes, edges, { isReversed: true })
     const startNode = nodes.find((node) => node.data.name === 'startAgentflow')
-    const startInputType = startNode?.data.inputs?.startInputType as 'chatInput' | 'formInput' | 'webhookTrigger'
+    const startInputType = startNode?.data.inputs?.startInputType as StartInputType | undefined
     if (!startInputType && !isRecursive) {
         throw new Error('Start input type not found')
     }
+
+    if (!isRecursive) {
+        if (startInputType === 'webhookTrigger' && chatType !== ChatType.WEBHOOK) {
+            const configuredMethod = ((startNode?.data?.inputs?.webhookMethod as string) || 'POST').toUpperCase()
+            throw new InternalFlowiseError(
+                StatusCodes.BAD_REQUEST,
+                `This flow is configured as a Webhook Trigger. Call ${configuredMethod} /api/v1/webhook/${chatflowid} instead of the prediction API.`
+            )
+        }
+        if (startInputType === 'scheduleInput' && chatType !== ChatType.SCHEDULED) {
+            throw new InternalFlowiseError(
+                StatusCodes.BAD_REQUEST,
+                `This flow is configured as a Scheduled Trigger. It is fired by the scheduler and cannot be invoked via the API. Change the Start node Input Type to Chat or Form to call it from the prediction API.`
+            )
+        }
+    }
     // @ts-ignore
     if (isTool) sseStreamer = undefined // If the request is from ChatflowTool, don't stream the response