Skip to main content
Glama

Update form settings

update_form_settings
Idempotent

Change a published Formhaus form's webhook, email notifications, success message, redirect, or pause/resume status without editing its fields. Send only settings to change; omitted ones stay.

Instructions

Call this to change how a published form behaves without touching its fields: webhook, email notifications, success message, redirect, or pause and resume. To change fields, publish a new version with publish_form and form_id instead. Changes the settings of a form of the account. Requires FORMHAUS_API_KEY to be an account key (fh_live_...); agent keys (fh_agent_..., also after a claim) get owner_key_required, and unclaimed forms are not found. Send only the settings to change; omitted ones stay. Returns form_id, status, success_message, redirect_url, notify_mode, webhook_url and a masked webhook_secret. Call reveal_webhook_secret for the full secret.

  • webhook_url: public https:// URL that receives each new submission as a signed JSON POST {form_id, submission_id, version, values, created_at}. Private, loopback, link-local and cloud metadata addresses are refused. Setting a URL on a form without one creates a new signing secret. Empty string removes the webhook.

  • notify_mode: "milestones" (default) emails the workspace members who turned on email notifications when the form reaches its 1st, 10th, 100th, 500th, 1,000th, 5,000th, 10,000th, 25,000th, 50,000th and 100,000th response; the emails hold a link to the responses and no response values. "off" sends nothing.

  • success_message: text shown after a submission on the hosted page and embed, up to 500 characters.

  • redirect_url: http(s) URL the hosted page and embed open after a submission. Empty string removes it.

  • status: "paused" stops accepting submissions, "active" resumes. A form paused after abuse answers paused_by_moderation.

Example: {"form_id": "abcDEF1234", "webhook_url": "https://example.com/api/formhaus"}

The receiver checks the Formhaus-Signature header t=,v1=<hex HMAC-SHA256 of t + "." + raw body, keyed with the full whsec_ secret>, rejects a t more than 5 minutes from now, compares in constant time and deduplicates by the Formhaus-Submission-Id header. On error, fix every listed setting and call again.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNopaused stops accepting submissions, active resumes them. Omit to leave it unchanged.
form_idYesThe 10-character form_id returned by publish_form or list_forms, such as "abcDEF1234".
notify_modeNomilestones: an email at the 1st, 10th, 100th, 500th, 1,000th, 5,000th, 10,000th, 25,000th, 50,000th and 100,000th response, without response values. off: no emails. Omit to leave it unchanged.
webhook_urlNoPublic https:// URL that receives each new submission as a signed POST. Empty string removes the webhook. Omit to leave it unchanged.
redirect_urlNohttp(s) URL the hosted page and embed open after a successful submission. Empty string removes it. Omit to leave it unchanged.
success_messageNoText shown after a successful submission on the hosted page and embed. Up to 500 characters. Omit to leave it unchanged.

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. Changed6 schema fields 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\"."
    • changedInput schema / properties / notify_mode / description
      Previous value: -"milestones: an email at the 1st, 10th, 100th, 500th, 1,000th, 5,000th, 10,000th, 25,000th, 50,000th and 100,000th response, without response values. off: no emails."New value: +"milestones: an email at the 1st, 10th, 100th, 500th, 1,000th, 5,000th, 10,000th, 25,000th, 50,000th and 100,000th response, without response values. off: no emails. Omit to leave it unchanged."
    • changedInput schema / properties / redirect_url / description
      Previous value: -"http(s) URL to open after a successful submission. Empty string removes it."New value: +"http(s) URL the hosted page and embed open after a successful submission. Empty string removes it. Omit to leave it unchanged."
    • changedInput schema / properties / status / description
      Previous value: -"active or paused."New value: +"paused stops accepting submissions, active resumes them. Omit to leave it unchanged."
    • changedInput schema / properties / success_message / description
      Previous value: -"Text shown after a successful submission. Up to 500 characters."New value: +"Text shown after a successful submission on the hosted page and embed. Up to 500 characters. Omit to leave it unchanged."
    • changedInput schema / properties / webhook_url / description
      Previous value: -"Public https:// URL for submission webhooks. Empty string removes it."New value: +"Public https:// URL that receives each new submission as a signed POST. Empty string removes the webhook. Omit to leave it unchanged."
  2. First observedv0.13.1

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover the safety profile (non-destructive, idempotent, open-world), and the description adds substantial context beyond them: partial-update semantics ('Send only the settings to change; omitted ones stay'), the exact auth requirement and its error (owner_key_required), the not-found behavior for unclaimed forms, secret creation on first webhook set, SSRF-style address refusals, and the paused_by_moderation state. This is unusually rich disclosure for a mutation tool.

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?

Front-loads purpose, routing, auth and partial-update semantics, then breaks each setting into a scannable bullet with an example payload. It is longer than strictly necessary: the closing paragraph on receiver-side signature verification (header format, 5-minute skew, constant-time compare, dedup) describes the consumer's implementation rather than this tool, which is useful context but adds bulk.

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?

An output schema exists, so return values need not be spelled out, yet the description still names the returned fields and the masked webhook_secret. Combined with auth requirements, partial-update behavior, per-field semantics, and the error-recovery instruction, an agent has everything needed to call this correctly on the first attempt.

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% with per-parameter descriptions and enums, so the baseline is 3. The description still adds meaning beyond the schema: that private/loopback/link-local/cloud-metadata URLs are refused, that setting a URL creates a new signing secret, and the exact milestone thresholds tied to notify_mode. It does not add much on form_id or success_message beyond 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?

States a specific verb+resource ('change how a published form behaves without touching its fields') and enumerates exactly which settings are in scope: webhook, notifications, success message, redirect, pause/resume. It explicitly distinguishes itself from publish_form for field changes, so an agent can separate the two without reading either 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 when-to-use routing ('To change fields, publish a new version with publish_form and form_id instead') and points to reveal_webhook_secret as the alternative for retrieving the full secret. It also states the prerequisite credential type (account key fh_live_...) and the failure mode for agent keys and unclaimed forms, which is exactly the guidance an agent needs before calling.

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