Skip to main content
Glama

Register a webhook

webhooks_set
Destructive

Register an https URL to receive job lifecycle events (job.completed / job.failed / job.cancelled) as HMAC-signed POSTs — push instead of polling. The whsec_ signing secret is returned ONCE; verify sceneplane-signature: t=<ms>,v1=hmac_sha256(secret, "<t>.<body>"). Requires owner/admin.

Input Schema

NameRequiredDescriptionDefault
urlYesHTTPS endpoint that receives signed terminal job events.
eventsNoJob event types to deliver to this webhook.

Output Schema

NameRequiredDescriptionDefault
eventsYes
secretYes
webhookIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Goes far beyond the annotations by disclosing the single-use secret return (the whsec_ secret is returned ONCE), the HMAC verification recipe with the exact signature header format, and the auth level required. The annotations already flag destructive and open-world behavior, and the description adds operational details an agent needs to correctly consume the registration.

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

Conciseness4/5

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

Two compact sentences, front-loaded with purpose and followed by implementation-critical caveats (secret returned once, signature verification, auth level). The signature formula is dense but earns its place because an agent calling this must capture the secret and document the verification contract.

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

Completeness5/5

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

Given the tool has an output schema (so returns need not be explained), the description supplies the secret-return lifecycle, the signature verification scheme, and the auth prerequisite. An agent can register the webhook and understand how to verify deliveries without external documentation.

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 coverage is 100%, so both parameters are documented (url as HTTPS endpoint, events as an array with defaults and allowed values). The description adds the event taxonomy and "https" constraint but does not add syntax or format semantics beyond the schema, so the baseline of 3 applies.

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?

States a precise verb and resource ("Register an https URL to receive job lifecycle events") and enumerates the exact event types delivered. Clearly distinguishes it from webhooks_list, webhooks_delete, and webhook_test by naming what registration actually does.

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

Usage Guidelines3/5

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

Offers "push instead of polling" as a rationale and states the "Requires owner/admin" prerequisite, which is useful context. However, it never explicitly says when to use webhooks_set vs. webhook_test, or that webhooks_list/delete exist for managing existing hooks, so an agent must infer the routing.

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