Skip to content

The open alternative to Salesforce, designed for AI.

1.8 KB
Raw Blame
import { ToolCategory } from 'twenty-shared/ai';
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 ToolExecuteArgs } from 'src/engine/core-modules/tool-provider/types/tool-execute-args.type';
import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
import { WEBHOOK_READ_ACCESS_POLICY } from 'src/engine/metadata-modules/webhook/constants/webhook-read-access-policy.constant';
import { WebhookService } from 'src/engine/metadata-modules/webhook/webhook.service';

const listWebhooksInputSchema = z.object({});

@DefineTool({
  name: 'list_webhooks',
  category: ToolCategory.WEBHOOK,
  accessPolicy: WEBHOOK_READ_ACCESS_POLICY,
  description: `List every webhook registered in the workspace. Returns id, targetUrl, operations (e.g. ['person.created','company.updated']), description and timestamps.`,
})
export class ListWebhooksTool extends BaseTool<typeof listWebhooksInputSchema> {
  readonly inputSchema = listWebhooksInputSchema;

  constructor(private readonly webhookService: WebhookService) {
    super();
  }

  async execute({
    context: { workspaceId },
  }: ToolExecuteArgs<typeof listWebhooksInputSchema>): Promise<ToolOutput> {
    const webhooks = await this.webhookService.findAll(workspaceId);

    return {
      success: true,
      message: `Found ${webhooks.length} webhook(s)`,
      result: {
        webhooks: webhooks.map((webhook) => ({
          id: webhook.id,
          targetUrl: webhook.targetUrl,
          operations: webhook.operations,
          description: webhook.description,
          createdAt: webhook.createdAt,
          updatedAt: webhook.updatedAt,
        })),
        count: webhooks.length,
      },
    };
  }
}