Skip to main content
Glama

Get the webhook of a form

get_webhook
Read-only

Check where a form's webhook posts and return its URL plus a masked signing secret; retrieve the full secret separately if your receiving server requires it.

Instructions

Call this to check where the webhook of a form posts; it shows only a masked secret, so call reveal_webhook_secret when the receiving server needs the full one, and update_form_settings to set or remove the URL. Returns the webhook URL and the masked signing secret. Requires an account key (fh_live_...); agent keys answer owner_key_required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
form_idYesThe 10-character form_id returned by publish_form or list_forms, such as "abcDEF1234".

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNoMachine-readable error code or message when the call failed.
noticeNo
form_idNo
messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.13.3
    • changedInput schema / properties / form_id / description
      Previous value: -"The form_id returned by publish_form or list_forms."New value: +"The 10-character form_id returned by publish_form or list_forms, such as \"abcDEF1234\"."
  2. First observedv0.13.1

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and openWorldHint, and the description adds substantial context beyond them: the secret is masked, the return payload contains URL plus masked signing secret, and it requires an account key (fh_live_...) while agent keys get owner_key_required. Auth behavior and return content are disclosed rather than left to inference.

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?

Front-loads the purpose, then routing to alternatives, then return and auth details across three dense sentences with no filler. Every clause carries decision-relevant information.

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?

Covers purpose, alternatives, return content, and the account-key auth requirement — the operational facts an agent needs for a one-parameter read tool. An output schema exists and is also summarized, so nothing material is missing.

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% and the single form_id parameter is fully documented in the schema (10-character id from publish_form/list_forms), so the description adds no parameter-level syntax or format detail. Baseline 3 applies when the schema does the heavy lifting.

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 specific verb and resource ('check where the webhook of a form posts') and immediately scopes it against two siblings by name. An agent can distinguish this from reveal_webhook_secret and update_form_settings without opening any schema.

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?

Gives explicit routing rules: use this for the masked secret, call reveal_webhook_secret when the receiving server needs the full one, and update_form_settings to set or remove the URL. Both alternatives are named with the condition that selects them.

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