Skip to main content
Glama

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

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden for behavioral disclosure. It adds some context by explaining webhooks receive job/monitor deliveries and can be associated with a project, but it does not describe side effects such as URL validation, immediate activation, or any test delivery behavior. The core action 'Create' is clear, but deeper behavioral nuances are omitted, which is a moderate 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 and well-structured: a one-sentence summary followed by clearly scoped use-case bullets. Every sentence earns its place, and it avoids redundant restatement of schema details. This is an efficient and readable format.

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?

The tool has 11 parameters and an output schema, so the description does not need to explain return values. It provides enough high-level context for selection and invocation, including primary use cases and the role of project_id, while relying on the fully described schema for parameter details. It could benefit from a brief example or mention of the output, but the provided context is adequate for a complex tool.

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%, so the baseline is 3 and the description need only add extra meaning. It does this for project_id by noting it can be passed at creation to associate the webhook from the start, but other parameters like type, method, and delivery_mode are not elaborated in the description beyond what the schema already states. Thus, it meets but does not exceed the baseline.

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 opens with 'Create a new webhook endpoint', which is a specific verb+resource statement that immediately clarifies the tool's action. It also distinguishes itself from sibling tools like get_webhook, update_webhook, and delete_webhook by focusing on creation, and adds use-case context that aligns with creating a new resource.

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 'Use when' bullet list provides explicit conditions for when this tool is appropriate, such as registering a URL, obtaining a webhook_id, or associating with a project. However, it does not explicitly mention when not to use it or suggest alternatives like assign_webhook_resource for attaching an existing webhook, so it falls short of 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.

TDQS

A3.6/5.0
Disambiguation4/5

Most tools have distinct purposes, but some pairs like create_dataset vs create_dataset_from_csv or pull_results vs pull_job_csv could cause confusion. However, descriptions clarify differences.

Naming Consistency4/5

Tools follow a consistent verb_noun pattern (e.g., create_dataset, list_datasets) with minor exceptions like append_csv_to_dataset and pull_job_csv. Overall predictable.

Tool Count3/5

60 tools is high for an MCP server, but the domain (web research, job processing, multiple resource types) justifies the count. Still borders on excessive.

Completeness5/5

The server offers full CRUD for datasets, entities, monitors, projects, webhooks, plus job submission, status polling, result retrieval (JSON/CSV), webhook management, and health endpoints. No obvious gaps.