Skip to main content
Glama

CatchAll (by NewsCatcher)

Create Webhook

create_webhook

Create a new webhook endpoint.

Use when:

  • You want to register a URL to receive job or monitor result deliveries.

  • You need a webhook_id to attach to a monitor (via webhook_ids) or a job submission.

  • You want the webhook associated with a project from the start (pass project_id).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesTarget URL that will receive webhook deliveries (required).
authNoOptional auth object forwarded with each delivery. One of: - {"type": "bearer", "token": "..."} - {"type": "api_key", "header": "X-API-Key", "value": "..."} - {"type": "basic", "username": "...", "password": "..."}
nameYesHuman-readable name for the webhook (required).
typeNoOptional webhook target type: 'generic' (default), 'slack', 'teams', or 'custom'. 'slack'/'teams' send pre-formatted payloads; 'generic'/'custom' send the raw result payload.
methodNoHTTP method for delivery (default 'POST'). One of GET, POST, PUT, PATCH, DELETE.POST
paramsNoOptional dict of query string parameters appended to the webhook URL.
api_keyNoCatchAll API key. Optional if provided via x-api-key header or CATCHALL_API_KEY env var.
headersNoOptional dict of custom HTTP headers to include in deliveries.
project_idNoOptional project ID to associate this webhook with immediately upon creation. A webhook can belong to several projects at once; use `add_project_resources` (resource_type 'webhook') to attach it to more.
delivery_modeNoOptional delivery mode: 'full' (default, whole result set in one call) or 'per_record' (one call per article).
formatter_configNoOptional custom payload transformation config dict.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / project_id
      Added value: +{
      +  "default": "",
      +  "description": "Optional project ID to associate this webhook with immediately\nupon creation. A webhook can belong to several projects at once; use\n`add_project_resources` (resource_type 'webhook') to attach it to more.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only says 'Create a new webhook endpoint' and lists use cases, but does not disclose any side effects, authentication requirements, validation behavior, or consequences of creation. For a mutation tool with zero annotation coverage, this is a significant gap.

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?

The description is concise, with the core purpose stated in the first sentence and the use cases formatted as a bulleted list. Every sentence earns its place, and the information is front-loaded and scannable for an agent.

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 the 11 parameters and the presence of an output schema, the description provides sufficient context for an agent to know when to call the tool and what the primary use cases are. The parameter details are handled by the schema, and the description covers the main decisions (when to use and the optional project association). It is slightly lacking in broader context about webhook behavior, but that is not essential for a create operation.

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?

The schema has 100% coverage, so the baseline is 3. The description adds minor semantic value by explaining when to use project_id ('associate with a project from the start'), but does not elaborate on other parameters beyond what the schema already documents. It neither compensates for gaps nor contradicts the schema.

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 states a specific verb (create) and resource (webhook endpoint), and the 'Use when' bullets clarify the exact scenarios for using this tool. It clearly distinguishes from siblings like update_webhook, delete_webhook, test_webhook, and trigger_webhook by focusing solely on 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 'Use when' conditions covering registration of URLs, obtaining a webhook_id, and associating with a project from the start. While it doesn't explicitly state when not to use or name alternative tools, the given conditions are specific and actionable, so it earns a 4 rather than a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources