Skip to main content
Glama
Newscatcher

CatchAll (by NewsCatcher)

Official

update_webhook

Modify an existing webhook's URL, method, headers, authentication, or active status. Update only the fields you provide; omitted fields remain unchanged.

Instructions

Update an existing webhook's configuration.

Use when:

  • You want to change a webhook's URL, method, headers, or other settings.

  • You want to enable or disable a webhook (set is_active).

  • Only the fields you provide are updated; omitted fields remain unchanged.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoUpdated target URL.
authNoUpdated auth object. One of: - {"type": "bearer", "token": "..."} - {"type": "api_key", "header": "X-API-Key", "value": "..."} - {"type": "basic", "username": "...", "password": "..."}
nameNoUpdated webhook name.
typeNoUpdated webhook type: 'generic', 'slack', 'teams', or 'custom'.
methodNoUpdated HTTP method: one of GET, POST, PUT, PATCH, DELETE.
paramsNoUpdated dict of query string parameters.
api_keyNoCatchAll API key. Optional if provided via x-api-key header or CATCHALL_API_KEY env var.
headersNoUpdated dict of custom HTTP headers.
is_activeNoSet to false to disable the webhook (stop deliveries), true to re-enable it.
webhook_idYesThe webhook ID to update.
delivery_modeNoUpdated delivery mode: 'full' or 'per_record'.
formatter_configNoUpdated formatter configuration dict.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

Discloses partial update ('only the fields you provide are updated; omitted fields remain unchanged'), which is key behavioral info beyond schema. No annotations provided, so description carries the burden; lacks details on error handling or permissions.

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?

Very concise: three sentences covering purpose, use cases, and behavior. Front-loaded with main action. No unnecessary words.

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?

Covers core use cases and partial update behavior. Output schema exists, so return values need not be explained. Could benefit from mentioning required webhook_id or potential errors, but overall sufficient for the complexity.

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 has 100% description coverage, so baseline is 3. Description adds little beyond listing example fields; does not explain syntax or constraints beyond what's in 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?

Description clearly states 'Update an existing webhook's configuration' with specific verb and resource. Distinguishes from sibling tools like create_webhook and delete_webhook by focusing on modification.

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?

Explicitly lists use cases (changing URL, method, headers, enabling/disabling) and notes partial update behavior. Does not explicitly mention when not to use, but context is clear.

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