Skip to main content
Glama

Update Webhook

update_webhook
Destructive

Update a webhook subscription (its url or event list). Pass webhookId + changed fields as body. The signing secret is NOT rotated here.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "webhookId": "<webhookId>",
      "body": "<body>"
    },
    "name": "update_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesPATCH /webhooks/:id body.
commandIdNoRetry identity. A call repeated with the same commandId returns the first result instead of acting twice.
webhookIdYeswebhookId (path).

Output Schema

NameRequiredDescriptionDefault
idNo
urlNo
eventsNo
enabledNo
settleMsNo
createdAtNo
lastFailedAtNo
lastDeliveredAtNo
verificationStatusNopending = callback URL has not echoed the ownership challenge (receives no events); verified = ownership proven.
consecutiveFailuresNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed20 schema fields changed
    • addedInput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "example": "https://hooks.example.com/cueframe",
      +    "format": "uri",
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "__schema1": {
      +    "items": {
      +      "$ref": "#/$defs/__schema2"
      +    },
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  "__schema2": {
      +    "enum": [
      +      "media.transcribed",
      +      "media.completed",
      +      "suggest.completed",
      +      "session.mux.complete",
      +      "session.mux.failed",
      +      "render.completed",
      +      "compose.completed",
      +      "checkpoint.ready",
      +      "project.updated",
      +      "composition.updated",
      +      "webhook.test"
      +    ],
      +    "type": "string"
      +  },
      +  "__schema3": {
      +    "maximum": 60000,
      +    "minimum": 0,
      +    "type": "integer"
      +  },
      +  "__schema4": {
      +    "type": "boolean"
      +  },
      +  "__schema5": {
      +    "maxLength": 128,
      +    "minLength": 1,
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / body / properties / enabled / $ref
      Added value: +"#/$defs/__schema4"
    • removedInput schema / properties / body / properties / enabled / type
      Removed value: -"boolean"
    • addedInput schema / properties / body / properties / events / $ref
      Added value: +"#/$defs/__schema1"
    • removedInput schema / properties / body / properties / events / items
      Removed value: -{
      -  "enum": [
      -    "media.transcribed",
      -    "media.completed",
      -    "suggest.completed",
      -    "session.mux.complete",
      -    "session.mux.failed",
      -    "render.completed",
      -    "compose.completed",
      -    "checkpoint.ready",
      -    "project.updated",
      -    "composition.updated",
      -    "webhook.test"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / body / properties / events / minItems
      Removed value: -1
    • removedInput schema / properties / body / properties / events / type
      Removed value: -"array"
    • addedInput schema / properties / body / properties / settleMs / $ref
      Added value: +"#/$defs/__schema3"
    • removedInput schema / properties / body / properties / settleMs / maximum
      Removed value: -60000
    • removedInput schema / properties / body / properties / settleMs / minimum
      Removed value: -0
    • removedInput schema / properties / body / properties / settleMs / type
      Removed value: -"integer"
    • addedInput schema / properties / body / properties / url / $ref
      Added value: +"#/$defs/__schema0"
    • removedInput schema / properties / body / properties / url / example
      Removed value: -"https://hooks.example.com/cueframe"
    • removedInput schema / properties / body / properties / url / format
      Removed value: -"uri"
    • removedInput schema / properties / body / properties / url / minLength
      Removed value: -1
    • removedInput schema / properties / body / properties / url / type
      Removed value: -"string"
    • addedInput schema / properties / commandId / $ref
      Added value: +"#/$defs/__schema5"
    • removedInput schema / properties / commandId / maxLength
      Removed value: -128
    • removedInput schema / properties / commandId / minLength
      Removed value: -1
    • removedInput schema / properties / commandId / type
      Removed value: -"string"
  2. Changed1 schema field changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Retry identity. A call repeated with the same commandId returns the first result instead of acting twice.",
      +  "maxLength": 128,
      +  "minLength": 1,
      +  "type": "string"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / body / properties / url / example
      Added value: +"https://hooks.example.com/cueframe"
  4. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, so the description's job is to explain what is destroyed or how retries behave. It adds the valuable negative disclosure that the signing secret is untouched and frames the call as a partial patch ("changed fields"), but says nothing about what makes this destructive or how the event list is replaced.

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 sentences, front-loaded with the verb and resource, then the calling convention, then the exclusion. No filler; the only inefficiency is that the parenthetical field list is incomplete relative to the schema.

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

Completeness3/5

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

Output schema and annotations carry much of the load, and schema descriptions cover all parameters. Still missing for a destructive mutation: whether `events` replaces or merges with the existing list, and what the destructiveHint actually entails — the most consequential ambiguity for this tool.

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 the baseline is 3; the description does confirm body is a partial patch at path webhookId. However it enumerates only url and event list and omits enabled and settleMs, which are valid body fields in the schema — a mild mismatch that adds little over structured data.

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+resource ("Update a webhook subscription") and narrows the mutable surface to url/event list, which separates it from create_webhook, delete_webhook and verify_webhook by verb alone. It stops short of naming any sibling explicitly, so 4 rather than 5.

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 signing secret is NOT rotated here" implicitly routes secret rotation elsewhere, which is a useful exclusion. But there is no explicit when-to-use guidance versus create_webhook/delete_webhook/verify_webhook, and no statement of prerequisites such as ownership or scope requirements.

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.