Skip to main content
Glama
jetapi

jetapi-mcp-server

Official
by jetapi

Create webhook

create_webhook

Register a webhook URL to receive real-time notifications for WhatsApp and Telegram events, enabling your server, CRM, or automation to react to messages and status updates.

Instructions

Register a webhook URL to receive real-time notifications for specific JetAPI events (e.g. whatsapp_log_out, delivery status updates, incoming messages). Use it when the user wants their server, CRM or automation (n8n, Make, Zapier) to receive replies or react to WhatsApp/Telegram events.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesHTTPS URL to receive notifications as POST requests.
typesYesEvent types: whatsapp_log_out (WhatsApp account disconnected); whatsapp_log_in (WhatsApp account connected); whatsapp_incoming_msg (incoming and outgoing WhatsApp messages (with file download links) and incoming WhatsApp calls); tdlib_incoming_msg (incoming and outgoing personal Telegram messages (with file download links) and Telegram calls); whatsapp_status_msg (statuses of outgoing WhatsApp messages: sent, received, read, played, failed, expired, …).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.2

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=true, which convey that this is a mutating, non-idempotent operation. The description adds minimal behavioral context ('receive real-time notifications'), which is more about purpose than behavior. It does not disclose success/failure details, webhook delivery mechanics, or any side effects beyond the annotation hints. With annotations covering the basic safety profile, a 3 is appropriate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no filler. The first sentence fronts the core purpose (register webhook) and scope (specific events), and the second sentence provides a concrete usage scenario. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a well-documented schema (100% coverage), clear annotations, and a simple creation operation, the description is sufficiently complete. It covers purpose and usage context. There is no output schema, but that is not required for this tool. It could optionally mention what happens after creation (e.g., whether a webhook ID is returned), but this is not necessary for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%: both 'url' (HTTPS URL to receive POST requests) and 'types' (with full enum descriptions for each event type) are well documented in the schema. The description does not add further parameter details beyond that; it only mentions event types incidentally. Baseline 3 is correct when the schema already carries the parameter semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Register a webhook URL') and the resource (webhook) with a specific purpose ('receive real-time notifications for specific JetAPI events'). It lists example event types, which helps distinguish it from sibling webhook management tools like list_webhooks, delete_webhook, and update_webhook. The verb 'Register' unambiguously signals creation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage context: 'Use it when the user wants their server, CRM or automation (n8n, Make, Zapier) to receive replies or react to WhatsApp/Telegram events.' This clearly identifies when to use the tool. It does not explicitly mention alternatives or exclusions, but for a create operation, the context is sufficient and not misleading.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.