Skip to main content
Glama

Send a test webhook

test_webhook

Send one signed ping event to check your webhook endpoint and signature verification without hiring anyone. Optional body {"webhook_url": "https://..."} (same rules as a job's webhook_url). Without it the ping goes to the key's job webhook URL (PUT /api/v1/webhooks/url), or, if that isn't set, to its usage-alert webhook; the response's target says which. Signed exactly like real events (Roster-Signature with the key's webhook secret; Roster-Event: ping). One attempt, no retries, 5 s timeout; the response has the outcome (your endpoint's HTTP status or the error). Free. Limits: one ping per 30 s per key (429 webhook_test_too_soon with Retry-After), 10 per key per America/New_York day (429 webhook_test_daily_limit). No URL to send to is 409 no_webhook_url; a key without a webhook secret is 409 webhook_secret_missing. Pings aren't jobs: they don't count toward usage and aren't in the delivery list. The same as POST /api/v1/webhooks/test.

Input Schema

NameRequiredDescriptionDefault
api_keyNoYour Roster API key (rk_test_... or rk_live_...), if your client can't send it as the Authorization header. Get one with get_sandbox_key or request_access.
webhook_urlNoOptional https URL on a public host to ping. Leave it out to ping the key's job webhook URL, or if none, its usage-alert webhook.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=false, openWorldHint=true), the description discloses the full behavioral profile: one attempt, no retries, 5 s timeout, signed with Roster-Signature and Roster-Event: ping, free, not counted as a job, excluded from the delivery list, and the two distinct 429 error codes with Retry-After. This is far richer than the annotations alone.

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?

Purpose is front-loaded and the dense detail is all relevant error/limit information. A few phrases ('without hiring anyone') add no value, and the single-wall-of-text format makes the fallback chain and error codes harder to scan than necessary, but nothing is truly wasted.

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?

For a 2-parameter tool with no output schema, the description covers everything an agent needs: target resolution, signature semantics, timeout/retry behavior, rate limits, distinct error codes, and side-effect profile (not a job, not in delivery list). Nothing material is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3. The description adds real meaning beyond the schema: it states the multipart fallback resolution order (explicit webhook_url → key's job webhook URL → usage-alert webhook) and that the response's target field tells you which was used. That resolves the main ambiguity an agent would have about the optional parameter.

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 a specific verb and resource ('Send one signed ping event to check your webhook endpoint and signature verification') and closes by naming the exact REST equivalent (POST /api/v1/webhooks/test). This clearly separates it from siblings like redeliver_webhook, list_webhook_deliveries, and set_webhook_events.

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

Usage Guidelines5/5

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

It explains exactly when to use it (verify endpoint reachability and signature verification before or alongside real traffic) and names the fallback chain when no URL is supplied. It also enumerates the when-not cases explicitly: 409 no_webhook_url, 409 webhook_secret_missing, and 429 rate/daily limits.

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