create_webhook

Instructions

Implementation Reference

• src/tools/webhooks.ts:31-39 (handler)

  Handler function for the create_webhook tool. Sends a POST request to the OpenWA API to create a new webhook with url, events, and optional secret.

    async ({ sessionId, url, events, secret }) => {
      const data = await openwaClient({
        method: "POST",
        path: `/sessions/${sessionId}/webhooks`,
        body: { url, events, secret },
      });
      return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] };
    }
  );

• src/tools/webhooks.ts:22-29 (schema)

  Schema definition for the create_webhook tool with sessionId, url, events (string array), and optional secret parameters.

  {
    description: "Create a new webhook to receive WhatsApp events at a URL",
    inputSchema: {
      sessionId: z.string().describe("Session ID"),
      url: z.string().describe("Webhook endpoint URL"),
      events: z.array(z.string()).describe("Array of event types to subscribe to"),
      secret: z.string().optional().describe("Optional webhook signing secret"),
    },

• src/tools/webhooks.ts:20-39 (registration)

  Registration of the create_webhook tool via server.registerTool within the registerWebhookTools function.

  server.registerTool(
    "create_webhook",
    {
      description: "Create a new webhook to receive WhatsApp events at a URL",
      inputSchema: {
        sessionId: z.string().describe("Session ID"),
        url: z.string().describe("Webhook endpoint URL"),
        events: z.array(z.string()).describe("Array of event types to subscribe to"),
        secret: z.string().optional().describe("Optional webhook signing secret"),
      },
    },
    async ({ sessionId, url, events, secret }) => {
      const data = await openwaClient({
        method: "POST",
        path: `/sessions/${sessionId}/webhooks`,
        body: { url, events, secret },
      });
      return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] };
    }
  );

• src/index.ts:9-20 (registration)

  Registration of the webhook tools module (including create_webhook) in the main server startup.

  import { registerWebhookTools } from "./tools/webhooks.js";
  import { registerLabelTools } from "./tools/labels.js";
  import { registerMediaTools } from "./tools/media.js";
  
  const server = new McpServer({ name: "openwa-mcp", version: "1.0.0" });
  
  registerSessionTools(server);
  registerMessageTools(server);
  registerBulkTools(server);
  registerGroupTools(server);
  registerContactTools(server);
  registerWebhookTools(server);

• src/client.ts:10-35 (helper)

  Helper HTTP client used by the create_webhook handler to make the POST request to the OpenWA API.

  export async function openwaClient<T = unknown>(opts: RequestOptions): Promise<T> {
    const url = `${BASE_URL}${opts.path}`;
  
    const headers: Record<string, string> = {
      "Content-Type": "application/json",
      "X-API-Key": API_KEY,
    };
  
    const res = await fetch(url, {
      method: opts.method,
      headers,
      body: opts.body ? JSON.stringify(opts.body) : undefined,
    });
  
    const text = await res.text();
  
    if (!res.ok) {
      throw new Error(`OpenWA API ${res.status}: ${text}`);
    }
  
    try {
      return JSON.parse(text) as T;
    } catch {
      return text as T;
    }
  }