Skip to content

The open alternative to Salesforce, designed for AI.

Migrate the remaining webhook tools to @DefineTool (#28417)

Paul Rastoinc7dc32975a2d
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/webhook-tool.provider.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/webhook-tool.provider.ts
deleted file mode 100644
index 33b73d51fe8..00000000000
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/webhook-tool.provider.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-import { Injectable } from '@nestjs/common';
-
-import { type ToolSet } from 'ai';
-import { ToolCategory } from 'twenty-shared/ai';
-import { PermissionFlagType } from 'twenty-shared/constants';
-
-import { type GenerateDescriptorOptions } from 'src/engine/core-modules/tool-provider/interfaces/generate-descriptor-options.type';
-import { type ToolProvider } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider.interface';
-import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
-import { type ToolDescriptor } from 'src/engine/core-modules/tool-provider/types/tool-descriptor.type';
-import { type ToolIndexEntry } from 'src/engine/core-modules/tool-provider/types/tool-index-entry.type';
-import { executeToolFromToolSet } from 'src/engine/core-modules/tool-provider/utils/execute-tool-from-tool-set.util';
-import { toolSetToDescriptors } from 'src/engine/core-modules/tool-provider/utils/tool-set-to-descriptors.util';
-import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
-import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
-import { WebhookToolWorkspaceService } from 'src/engine/metadata-modules/webhook/tools/services/webhook-tool.workspace-service';
-
-@Injectable()
-export class WebhookToolProvider implements ToolProvider {
- readonly category = ToolCategory.WEBHOOK;
-
- constructor(
- private readonly webhookToolService: WebhookToolWorkspaceService,
- private readonly permissionsService: PermissionsService,
- ) {}
-
- async isAvailable(context: ToolProviderContext): Promise<boolean> {
- return this.permissionsService.checkRolesPermissions(
- context.rolePermissionConfig,
- context.workspaceId,
- PermissionFlagType.API_KEYS_AND_WEBHOOKS,
- );
- }
-
- async generateDescriptors(
- context: ToolProviderContext,
- options?: GenerateDescriptorOptions,
- ): Promise<(ToolIndexEntry | ToolDescriptor)[]> {
- return toolSetToDescriptors(
- this.buildToolSet(context),
- ToolCategory.WEBHOOK,
- { includeSchemas: options?.includeSchemas ?? true },
- );
- }
-
- async executeStaticTool(
- toolName: string,
- args: Record<string, unknown>,
- context: ToolProviderContext,
- ): Promise<ToolOutput> {
- return executeToolFromToolSet(
- this.buildToolSet(context),
- toolName,
- args,
- ToolCategory.WEBHOOK,
- );
- }
-
- private buildToolSet(context: ToolProviderContext): ToolSet {
- return this.webhookToolService.generateWebhookTools(context.workspaceId);
- }
-}
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts
index 737faae1d3d..c26d917c9bb 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/tool-provider.module.ts
@@ -16,7 +16,6 @@ import { MetadataToolProvider } from 'src/engine/core-modules/tool-provider/prov
import { NavigationMenuItemToolProvider } from 'src/engine/core-modules/tool-provider/providers/navigation-menu-item-tool.provider';
import { RoleToolProvider } from 'src/engine/core-modules/tool-provider/providers/role-tool.provider';
import { ViewToolProvider } from 'src/engine/core-modules/tool-provider/providers/view-tool.provider';
-import { WebhookToolProvider } from 'src/engine/core-modules/tool-provider/providers/webhook-tool.provider';
import { WorkflowToolProvider } from 'src/engine/core-modules/tool-provider/providers/workflow-tool.provider';
import { DefinedToolRegistryService } from 'src/engine/core-modules/tool-provider/services/defined-tool-registry.service';
import { RecordFilesResolverService } from 'src/engine/core-modules/tool-provider/services/record-files-resolver.service';
@@ -89,7 +88,6 @@ import { ToolRegistryService } from './services/tool-registry.service';
LogicFunctionToolProvider,
RoleToolProvider,
ViewToolProvider,
- WebhookToolProvider,
WorkflowToolProvider,
{
provide: TOOL_PROVIDERS,
@@ -101,7 +99,6 @@ import { ToolRegistryService } from './services/tool-registry.service';
navigationMenuItemProvider: NavigationMenuItemToolProvider,
roleProvider: RoleToolProvider,
viewProvider: ViewToolProvider,
- webhookProvider: WebhookToolProvider,
workflowProvider: WorkflowToolProvider,
dashboardProvider: DashboardToolProvider,
agentProvider: AgentToolProvider,
@@ -113,7 +110,6 @@ import { ToolRegistryService } from './services/tool-registry.service';
navigationMenuItemProvider,
roleProvider,
viewProvider,
- webhookProvider,
workflowProvider,
dashboardProvider,
agentProvider,
@@ -126,7 +122,6 @@ import { ToolRegistryService } from './services/tool-registry.service';
NavigationMenuItemToolProvider,
RoleToolProvider,
ViewToolProvider,
- WebhookToolProvider,
WorkflowToolProvider,
DashboardToolProvider,
AgentToolProvider,
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/create-webhook.tool.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/create-webhook.tool.ts
index 04e1f7b4828..0b5b37a8ece 100644
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/create-webhook.tool.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/create-webhook.tool.ts
@@ -1,11 +1,16 @@
+import { ToolCategory } from 'twenty-shared/ai';
+import { PermissionFlagType } from 'twenty-shared/constants';
import { z } from 'zod';
+import { DefineTool } from 'src/engine/core-modules/tool-provider/decorators/define-tool.decorator';
+import { BaseTool } from 'src/engine/core-modules/tool-provider/interfaces/base-tool.interface';
+import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
+import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
import { webhookOperationSchema } from 'src/engine/metadata-modules/webhook/tools/schemas/webhook-operation.schema';
-import { type WebhookToolContext } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-context.type';
-import { type WebhookToolDependencies } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type';
import { compileWebhookOperations } from 'src/engine/metadata-modules/webhook/tools/utils/compile-webhook-operations.util';
+import { WebhookService } from 'src/engine/metadata-modules/webhook/webhook.service';
-const createWebhookSchema = z.object({
+const createWebhookInputSchema = z.object({
targetUrl: z
.string()
.url()
@@ -23,13 +28,10 @@ const createWebhookSchema = z.object({
),
});
-type CreateWebhookParams = z.infer<typeof createWebhookSchema>;
-
-export const createCreateWebhookTool = (
- deps: Pick<WebhookToolDependencies, 'webhookService'>,
- context: WebhookToolContext,
-) => ({
- name: 'create_webhook' as const,
+@DefineTool({
+ name: 'create_webhook',
+ category: ToolCategory.WEBHOOK,
+ requiredPermissionFlags: [PermissionFlagType.API_KEYS_AND_WEBHOOKS],
description: `Register a new outgoing webhook for this workspace.
Operations are structured entries discriminated by 'kind':
@@ -39,16 +41,33 @@ Operations are structured entries discriminated by 'kind':
- {kind:'metadata', metadataName:'*', operation:'*'} → fires on every metadata change.
Mix as needed: pass one array containing both record and metadata operations.`,
- inputSchema: createWebhookSchema,
- execute: async (parameters: CreateWebhookParams) => {
- const webhook = await deps.webhookService.create(
+})
+export class CreateWebhookTool extends BaseTool<
+ typeof createWebhookInputSchema
+> {
+ readonly inputSchema = createWebhookInputSchema;
+
+ constructor(private readonly webhookService: WebhookService) {
+ super();
+ }
+
+ async execute(
+ {
+ targetUrl,
+ operations,
+ description,
+ secret,
+ }: z.infer<typeof createWebhookInputSchema>,
+ { workspaceId }: ToolProviderContext,
+ ): Promise<ToolOutput> {
+ const webhook = await this.webhookService.create(
{
- targetUrl: parameters.targetUrl,
- operations: compileWebhookOperations(parameters.operations),
- description: parameters.description,
- secret: parameters.secret,
+ targetUrl,
+ operations: compileWebhookOperations(operations),
+ description,
+ secret,
},
- context.workspaceId,
+ workspaceId,
);
return {
@@ -61,5 +80,5 @@ Mix as needed: pass one array containing both record and metadata operations.`,
description: webhook.description,
},
};
- },
-});
+ }
+}
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/list-webhooks.tool.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/list-webhooks.tool.ts
index df0149dc25d..964f9e836e2 100644
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/list-webhooks.tool.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/list-webhooks.tool.ts
@@ -1,19 +1,33 @@
+import { ToolCategory } from 'twenty-shared/ai';
+import { PermissionFlagType } from 'twenty-shared/constants';
import { z } from 'zod';
-import { type WebhookToolContext } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-context.type';
-import { type WebhookToolDependencies } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type';
+import { DefineTool } from 'src/engine/core-modules/tool-provider/decorators/define-tool.decorator';
+import { BaseTool } from 'src/engine/core-modules/tool-provider/interfaces/base-tool.interface';
+import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
+import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
+import { WebhookService } from 'src/engine/metadata-modules/webhook/webhook.service';
-const listWebhooksSchema = z.object({});
+const listWebhooksInputSchema = z.object({});
-export const createListWebhooksTool = (
- deps: Pick<WebhookToolDependencies, 'webhookService'>,
- context: WebhookToolContext,
-) => ({
- name: 'list_webhooks' as const,
+@DefineTool({
+ name: 'list_webhooks',
+ category: ToolCategory.WEBHOOK,
+ requiredPermissionFlags: [PermissionFlagType.API_KEYS_AND_WEBHOOKS],
description: `List every webhook registered in the workspace. Returns id, targetUrl, operations (e.g. ['person.created','company.updated']), description and timestamps.`,
- inputSchema: listWebhooksSchema,
- execute: async () => {
- const webhooks = await deps.webhookService.findAll(context.workspaceId);
+})
+export class ListWebhooksTool extends BaseTool<typeof listWebhooksInputSchema> {
+ readonly inputSchema = listWebhooksInputSchema;
+
+ constructor(private readonly webhookService: WebhookService) {
+ super();
+ }
+
+ async execute(
+ _input: z.infer<typeof listWebhooksInputSchema>,
+ { workspaceId }: ToolProviderContext,
+ ): Promise<ToolOutput> {
+ const webhooks = await this.webhookService.findAll(workspaceId);
return {
success: true,
@@ -30,5 +44,5 @@ export const createListWebhooksTool = (
count: webhooks.length,
},
};
- },
-});
+ }
+}
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/services/webhook-tool.workspace-service.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/services/webhook-tool.workspace-service.ts
deleted file mode 100644
index 67170a9f487..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/services/webhook-tool.workspace-service.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-import { Injectable } from '@nestjs/common';
-
-import { type ToolSet } from 'ai';
-
-import { WebhookService } from 'src/engine/metadata-modules/webhook/webhook.service';
-import { createCreateWebhookTool } from 'src/engine/metadata-modules/webhook/tools/create-webhook.tool';
-import { createListWebhooksTool } from 'src/engine/metadata-modules/webhook/tools/list-webhooks.tool';
-import { type WebhookToolDependencies } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type';
-import { createUpdateWebhookTool } from 'src/engine/metadata-modules/webhook/tools/update-webhook.tool';
-
-@Injectable()
-export class WebhookToolWorkspaceService {
- private readonly deps: WebhookToolDependencies;
-
- constructor(webhookService: WebhookService) {
- this.deps = { webhookService };
- }
-
- generateWebhookTools(workspaceId: string): ToolSet {
- const context = { workspaceId };
-
- const listWebhooks = createListWebhooksTool(this.deps, context);
- const createWebhook = createCreateWebhookTool(this.deps, context);
- const updateWebhook = createUpdateWebhookTool(this.deps, context);
-
- return {
- [listWebhooks.name]: listWebhooks,
- [createWebhook.name]: createWebhook,
- [updateWebhook.name]: updateWebhook,
- };
- }
-}
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/types/webhook-tool-context.type.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/types/webhook-tool-context.type.ts
deleted file mode 100644
index 1a49f79a575..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/types/webhook-tool-context.type.ts
+++ /dev/null
@@ -1,3 +0,0 @@
-export type WebhookToolContext = {
- workspaceId: string;
-};
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type.ts
deleted file mode 100644
index b3887a8b964..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-import type { WebhookService } from 'src/engine/metadata-modules/webhook/webhook.service';
-
-export type WebhookToolDependencies = {
- webhookService: WebhookService;
-};
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/update-webhook.tool.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/update-webhook.tool.ts
index f7461c21947..30fd51ba7c1 100644
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/update-webhook.tool.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/update-webhook.tool.ts
@@ -1,11 +1,16 @@
+import { ToolCategory } from 'twenty-shared/ai';
+import { PermissionFlagType } from 'twenty-shared/constants';
import { z } from 'zod';
+import { DefineTool } from 'src/engine/core-modules/tool-provider/decorators/define-tool.decorator';
+import { BaseTool } from 'src/engine/core-modules/tool-provider/interfaces/base-tool.interface';
+import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
+import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
import { webhookOperationSchema } from 'src/engine/metadata-modules/webhook/tools/schemas/webhook-operation.schema';
-import { type WebhookToolContext } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-context.type';
-import { type WebhookToolDependencies } from 'src/engine/metadata-modules/webhook/tools/types/webhook-tool-dependencies.type';
import { compileWebhookOperations } from 'src/engine/metadata-modules/webhook/tools/utils/compile-webhook-operations.util';
+import { WebhookService } from 'src/engine/metadata-modules/webhook/webhook.service';
-const updateWebhookSchema = z.object({
+const updateWebhookInputSchema = z.object({
id: z.uuid().describe('The id of the webhook to update'),
targetUrl: z
.string()
@@ -19,16 +24,25 @@ const updateWebhookSchema = z.object({
secret: z.string().optional(),
});
-type UpdateWebhookParams = z.infer<typeof updateWebhookSchema>;
-
-export const createUpdateWebhookTool = (
- deps: Pick<WebhookToolDependencies, 'webhookService'>,
- context: WebhookToolContext,
-) => ({
- name: 'update_webhook' as const,
+@DefineTool({
+ name: 'update_webhook',
+ category: ToolCategory.WEBHOOK,
+ requiredPermissionFlags: [PermissionFlagType.API_KEYS_AND_WEBHOOKS],
description: `Update an existing webhook. Only the fields you pass are modified; everything else is preserved.`,
- inputSchema: updateWebhookSchema,
- execute: async (parameters: UpdateWebhookParams) => {
+})
+export class UpdateWebhookTool extends BaseTool<
+ typeof updateWebhookInputSchema
+> {
+ readonly inputSchema = updateWebhookInputSchema;
+
+ constructor(private readonly webhookService: WebhookService) {
+ super();
+ }
+
+ async execute(
+ parameters: z.infer<typeof updateWebhookInputSchema>,
+ { workspaceId }: ToolProviderContext,
+ ): Promise<ToolOutput> {
const update: {
targetUrl?: string;
operations?: string[];
@@ -49,9 +63,9 @@ export const createUpdateWebhookTool = (
update.secret = parameters.secret;
}
- const webhook = await deps.webhookService.update(
+ const webhook = await this.webhookService.update(
{ id: parameters.id, update },
- context.workspaceId,
+ workspaceId,
);
return {
@@ -64,5 +78,5 @@ export const createUpdateWebhookTool = (
description: webhook.description,
},
};
- },
-});
+ }
+}
diff --git a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/webhook-tools.module.ts b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/webhook-tools.module.ts
index 88227e236b8..aab5fb5013e 100644
--- a/packages/twenty-server/src/engine/metadata-modules/webhook/tools/webhook-tools.module.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/webhook/tools/webhook-tools.module.ts
@@ -1,12 +1,18 @@
import { Module } from '@nestjs/common';
+import { CreateWebhookTool } from 'src/engine/metadata-modules/webhook/tools/create-webhook.tool';
import { DeleteWebhookTool } from 'src/engine/metadata-modules/webhook/tools/delete-webhook.tool';
-import { WebhookToolWorkspaceService } from 'src/engine/metadata-modules/webhook/tools/services/webhook-tool.workspace-service';
+import { ListWebhooksTool } from 'src/engine/metadata-modules/webhook/tools/list-webhooks.tool';
+import { UpdateWebhookTool } from 'src/engine/metadata-modules/webhook/tools/update-webhook.tool';
import { WebhookModule } from 'src/engine/metadata-modules/webhook/webhook.module';
@Module({
imports: [WebhookModule],
- providers: [WebhookToolWorkspaceService, DeleteWebhookTool],
- exports: [WebhookToolWorkspaceService],
+ providers: [
+ ListWebhooksTool,
+ CreateWebhookTool,
+ UpdateWebhookTool,
+ DeleteWebhookTool,
+ ],
})
export class WebhookToolsModule {}
diff --git a/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-webhook-tools.integration-spec.ts.snap b/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-webhook-tools.integration-spec.ts.snap
index 1daff25b0d6..edd5176fd1f 100644
--- a/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-webhook-tools.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-webhook-tools.integration-spec.ts.snap
@@ -1,7 +1,215 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
-exports[`MCP webhook tools (integration) should describe delete_webhook to the model 1`] = `
+exports[`MCP webhook tools (integration) should describe the webhook tools to the model 1`] = `
[
+ {
+ "description": "List every webhook registered in the workspace. Returns id, targetUrl, operations (e.g. ['person.created','company.updated']), description and timestamps.",
+ "inputSchema": {
+ "properties": {},
+ "type": "object",
+ },
+ "name": "list_webhooks",
+ },
+ {
+ "description": "Register a new outgoing webhook for this workspace.
+
+Operations are structured entries discriminated by 'kind':
+- {kind:'record', object:'person', event:'created'} → fires when a person is created (compiles to 'person.created').
+- {kind:'record', object:'*', event:'*'} → fires on every record event except 'workflowRun.updated', which only matches an explicit {kind:'record', object:'workflowRun', event:'updated'} entry.
+- {kind:'metadata', metadataName:'workflow', operation:'updated'} → fires when a workflow definition is updated (compiles to 'metadata.workflow.updated').
+- {kind:'metadata', metadataName:'*', operation:'*'} → fires on every metadata change.
+
+Mix as needed: pass one array containing both record and metadata operations.",
+ "inputSchema": {
+ "properties": {
+ "description": {
+ "description": "Optional human description for the webhook",
+ "type": "string",
+ },
+ "operations": {
+ "description": "Events that trigger the webhook. Record events compile to '<object>.<event>' (e.g. 'person.created'). Metadata events compile to 'metadata.<metadataName>.<operation>' (e.g. 'metadata.workflow.updated'). Use [{kind:'record',object:'*',event:'*'}] to subscribe to all record events. Exception: 'workflowRun.updated' never matches wildcards and requires an explicit {kind:'record',object:'workflowRun',event:'updated'} entry.",
+ "items": {
+ "anyOf": [
+ {
+ "properties": {
+ "event": {
+ "description": "Event kind. Use '*' to match every event for the given object.",
+ "enum": [
+ "created",
+ "updated",
+ "deleted",
+ "*",
+ ],
+ "type": "string",
+ },
+ "kind": {
+ "const": "record",
+ "description": "Record event ('<objectNameSingular>.<event>')",
+ "type": "string",
+ },
+ "object": {
+ "description": "Object name singular (e.g. 'person', 'company', 'task'), or '*' for all objects.",
+ "minLength": 1,
+ "type": "string",
+ },
+ },
+ "required": [
+ "kind",
+ "object",
+ "event",
+ ],
+ "type": "object",
+ },
+ {
+ "properties": {
+ "kind": {
+ "const": "metadata",
+ "description": "Metadata event ('metadata.<metadataName>.<operation>') — fires on changes to objects, fields, views, workflows, etc.",
+ "type": "string",
+ },
+ "metadataName": {
+ "description": "Metadata name (e.g. 'object', 'field', 'view', 'workflow'), or '*' for all.",
+ "minLength": 1,
+ "type": "string",
+ },
+ "operation": {
+ "description": "Operation kind. Use '*' to match every operation.",
+ "enum": [
+ "created",
+ "updated",
+ "deleted",
+ "*",
+ ],
+ "type": "string",
+ },
+ },
+ "required": [
+ "kind",
+ "metadataName",
+ "operation",
+ ],
+ "type": "object",
+ },
+ ],
+ },
+ "minItems": 1,
+ "type": "array",
+ },
+ "secret": {
+ "description": "Optional shared secret used to sign payloads. A secret is generated if omitted.",
+ "type": "string",
+ },
+ "targetUrl": {
+ "description": "Absolute URL the webhook payload should be POSTed to",
+ "format": "uri",
+ "type": "string",
+ },
+ },
+ "required": [
+ "targetUrl",
+ "operations",
+ ],
+ "type": "object",
+ },
+ "name": "create_webhook",
+ },
+ {
+ "description": "Update an existing webhook. Only the fields you pass are modified; everything else is preserved.",
+ "inputSchema": {
+ "properties": {
+ "description": {
+ "type": "string",
+ },
+ "id": {
+ "description": "The id of the webhook to update",
+ "format": "uuid",
+ "type": "string",
+ },
+ "operations": {
+ "description": "Replaces the operations list. Leave unset to keep current.",
+ "items": {
+ "anyOf": [
+ {
+ "properties": {
+ "event": {
+ "description": "Event kind. Use '*' to match every event for the given object.",
+ "enum": [
+ "created",
+ "updated",
+ "deleted",
+ "*",
+ ],
+ "type": "string",
+ },
+ "kind": {
+ "const": "record",
+ "description": "Record event ('<objectNameSingular>.<event>')",
+ "type": "string",
+ },
+ "object": {
+ "description": "Object name singular (e.g. 'person', 'company', 'task'), or '*' for all objects.",
+ "minLength": 1,
+ "type": "string",
+ },
+ },
+ "required": [
+ "kind",
+ "object",
+ "event",
+ ],
+ "type": "object",
+ },
+ {
+ "properties": {
+ "kind": {
+ "const": "metadata",
+ "description": "Metadata event ('metadata.<metadataName>.<operation>') — fires on changes to objects, fields, views, workflows, etc.",
+ "type": "string",
+ },
+ "metadataName": {
+ "description": "Metadata name (e.g. 'object', 'field', 'view', 'workflow'), or '*' for all.",
+ "minLength": 1,
+ "type": "string",
+ },
+ "operation": {
+ "description": "Operation kind. Use '*' to match every operation.",
+ "enum": [
+ "created",
+ "updated",
+ "deleted",
+ "*",
+ ],
+ "type": "string",
+ },
+ },
+ "required": [
+ "kind",
+ "metadataName",
+ "operation",
+ ],
+ "type": "object",
+ },
+ ],
+ },
+ "minItems": 1,
+ "type": "array",
+ },
+ "secret": {
+ "type": "string",
+ },
+ "targetUrl": {
+ "description": "New target URL. Leave unset to keep the current value.",
+ "format": "uri",
+ "type": "string",
+ },
+ },
+ "required": [
+ "id",
+ ],
+ "type": "object",
+ },
+ "name": "update_webhook",
+ },
{
"description": "Delete a webhook by id. Use list_webhooks first if you don't know the id.",
"inputSchema": {
diff --git a/packages/twenty-server/test/integration/ai/suites/mcp-webhook-tools.integration-spec.ts b/packages/twenty-server/test/integration/ai/suites/mcp-webhook-tools.integration-spec.ts
index c988b1ac671..7313dc2584d 100644
--- a/packages/twenty-server/test/integration/ai/suites/mcp-webhook-tools.integration-spec.ts
+++ b/packages/twenty-server/test/integration/ai/suites/mcp-webhook-tools.integration-spec.ts
@@ -25,10 +25,17 @@ describe('MCP webhook tools (integration)', () => {
}
});
- it('should describe delete_webhook to the model', async () => {
+ it('should describe the webhook tools to the model', async () => {
const result = await callMcpTool({
toolName: 'learn_tools',
- toolArguments: { toolNames: ['delete_webhook'] },
+ toolArguments: {
+ toolNames: [
+ 'list_webhooks',
+ 'create_webhook',
+ 'update_webhook',
+ 'delete_webhook',
+ ],
+ },
token: API_KEY_ACCESS_TOKEN,
});
@@ -40,7 +47,7 @@ describe('MCP webhook tools (integration)', () => {
expect(payload.tools).toMatchSnapshot();
});
- it('should delete a webhook created through create_webhook', async () => {
+ it('should create, update and delete a webhook', async () => {
const created = await executeToolThroughMcp<{ id: string }>({
toolName: 'create_webhook',
toolArguments: {
@@ -54,8 +61,34 @@ describe('MCP webhook tools (integration)', () => {
const webhookId = created.result?.id;
jestExpectToBeDefined(webhookId);
+ expect(created.result).toEqual({
+ id: webhookId,
+ targetUrl: TARGET_URL,
+ operations: ['person.created'],
+ description: null,
+ });
expect(await listWebhookIdsThroughMcp()).toContain(webhookId);
+ const updated = await executeToolThroughMcp({
+ toolName: 'update_webhook',
+ toolArguments: {
+ id: webhookId,
+ description: 'Notify the sales channel',
+ operations: [{ kind: 'metadata', metadataName: '*', operation: '*' }],
+ },
+ });
+
+ expect(updated).toEqual({
+ success: true,
+ message: `Webhook ${webhookId} updated`,
+ result: {
+ id: webhookId,
+ targetUrl: TARGET_URL,
+ operations: ['metadata.*.*'],
+ description: 'Notify the sales channel',
+ },
+ });
+
const deleted = await executeToolThroughMcp({
toolName: 'delete_webhook',
toolArguments: { id: webhookId },