Skip to main content
Glama

Update Webhook

update_webhook
Destructive

Update an incoming webhook (by id) on a room the account owns — e.g. change its icon, title, message, or sound.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNoA v3 room-icon catalog id, e.g. "bell". Call list_room_icons to discover the valid ids.
nameNoWebhook name (shown to the owner).
colorNoHex color, e.g. "#e33122".
soundNoCanonical sound id, e.g. "ting".
titleNoPush title used when the webhook fires.
enabledNoWhether the webhook is active.
messageNoDefault push body (max 120 characters in private rooms, 160 in public rooms).
webhook_idYesWebhook id (from list_webhooks or create_webhook).
invite_codeYesRoom invite code.
action_numberNoQuick-action slot whose label, sound, and acknowledgement preset fires use. Pass null to clear the preset and make the webhook independent.
cooldown_secondsNoMinimum seconds between fires.
regenerate_secretNoRotate the secret trigger URL.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesAn incoming webhook. `webhook_url` embeds the secret — treat it as a credential.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / action_number / description
      Previous value: -"Quick-action slot to attribute fires to."New value: +"Quick-action slot whose label, sound, and acknowledgement preset fires use. Pass null to clear the preset and make the webhook independent."
    • changedInput schema / properties / action_number / type
      Previous value: -"integer"New value: +[
      +  "integer",
      +  "null"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / action_number / maximum
      Previous value: -4New value: +16
  3. Changed4 schema fields changed
    • addedOutput schema / properties / result / additionalProperties
      Added value: +false
    • changedOutput schema / properties / result / description
      Previous value: -"Purpose-built PingRoom result with credential and account fields removed."New value: +"An incoming webhook. `webhook_url` embeds the secret — treat it as a credential."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "action_number": {
      +    "type": [
      +      "integer",
      +      "null"
      +    ]
      +  },
      +  "color": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "cooldown_seconds": {
      +    "type": [
      +      "integer",
      +      "null"
      +    ]
      +  },
      +  "enabled": {
      +    "type": "boolean"
      +  },
      +  "icon": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "id": {
      +    "format": "uuid",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "message": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "name": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "sound": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "title": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "webhook_url": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  }
      +}
    • addedOutput schema / properties / result / type
      Added value: +"object"
  4. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and readOnlyHint=false, so the mutation/safety profile is covered. The description adds the ownership scope, but is silent on notable side effects the schema reveals, e.g. that regenerate_secret rotates the trigger URL or that passing null for action_number clears a preset.

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?

A single sentence with zero waste; the operation is front-loaded and the scope restriction follows immediately. Nothing to trim.

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?

For a 12-parameter mutation tool with a fully documented schema, an output schema, and annotations, the description is adequate: purpose, identifier, and ownership scope are covered. It stops short of flagging destructive side effects like secret rotation, but the structured fields largely carry that load.

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 all 12 parameters are fully documented in the schema; baseline is 3. The description only echoes icon/title/message/sound and adds no format or constraint detail beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Update an incoming webhook (by id)') and adds scope ('on a room the account owns') plus example fields. 'Update' implicitly distinguishes it from create_webhook/delete_webhook siblings, though no sibling is named explicitly.

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?

The phrase 'on a room the account owns' hints at a prerequisite, but there is no explicit when-to-use guidance, no exclusion conditions, and no routing to alternatives such as create_webhook or delete_webhook. Usage is only implied from the verb.

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