Skip to main content
Glama

Update a webhook

update_webhook
Destructive

Modify an existing webhook's URL and allowed event types. Use when you need to change where notifications are sent or which events trigger them.

Instructions

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Update a webhook

Input Schema

NameRequiredDescriptionDefault
urlNo
accountNoExact private shop profile label; not a provider identity or authorization proof.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete current native JSON body; cannot mix with native body flags or payload_file.
allowedTypesNo
payload_fileNoAbsolute regular non-symlink native JSON body file, at most1MiB. Cannot mix with payload or body flags.
webhook_configuration_idYesNative webhookConfigurationId

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "allowedTypes": {
      +    "items": {
      +      "enum": [
      +        "ORDER_PLACED",
      +        "ORDER_UPDATED",
      +        "GIFT_PURCHASE",
      +        "PRODUCT_CREATED",
      +        "PRODUCT_UPDATED",
      +        "DONATION",
      +        "SUBSCRIPTION_PURCHASED",
      +        "SUBSCRIPTION_EXPIRED",
      +        "SUBSCRIPTION_CHANGED",
      +        "NEWSLETTER_SUBSCRIBED",
      +        "THANK_YOU_SENT",
      +        "GIFT_DRAW_STARTED",
      +        "GIFT_DRAW_ENDED",
      +        "PROMOTION_CREATED",
      +        "PROMOTION_UPDATED",
      +        "PROMOTION_STATUS_CHANGED",
      +        "PLATFORM_APP_DISCONNECTED",
      +        "MEMBERSHIP_POST_UPSERTED",
      +        "MEMBERSHIP_SERIES_UPSERTED",
      +        "MEMBERSHIP_SERIES_DELETED",
      +        "MEMBERSHIP_TAG_CREATED",
      +        "MEMBERSHIP_TAG_UPDATED",
      +        "MEMBERSHIP_TAG_DELETED",
      +        "MEMBERSHIP_TIER_UPSERTED",
      +        "MEMBERSHIP_TIER_DELETED",
      +        "COLLECTION_UPDATED",
      +        "CART_ABANDONED_1H",
      +        "CART_ABANDONED_24H",
      +        "CART_ABANDONED_72H"
      +      ],
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +}
    • addedInput schema / properties / allowedTypes / $ref
      Added value: +"#/$defs/allowedTypes"
    • removedInput schema / properties / allowedTypes / items
      Removed value: -{
      -  "enum": [
      -    "ORDER_PLACED",
      -    "ORDER_UPDATED",
      -    "GIFT_PURCHASE",
      -    "PRODUCT_CREATED",
      -    "PRODUCT_UPDATED",
      -    "DONATION",
      -    "SUBSCRIPTION_PURCHASED",
      -    "SUBSCRIPTION_EXPIRED",
      -    "SUBSCRIPTION_CHANGED",
      -    "NEWSLETTER_SUBSCRIBED",
      -    "THANK_YOU_SENT",
      -    "GIFT_DRAW_STARTED",
      -    "GIFT_DRAW_ENDED",
      -    "PROMOTION_CREATED",
      -    "PROMOTION_UPDATED",
      -    "PROMOTION_STATUS_CHANGED",
      -    "PLATFORM_APP_DISCONNECTED",
      -    "MEMBERSHIP_POST_UPSERTED",
      -    "MEMBERSHIP_SERIES_UPSERTED",
      -    "MEMBERSHIP_SERIES_DELETED",
      -    "MEMBERSHIP_TAG_CREATED",
      -    "MEMBERSHIP_TAG_UPDATED",
      -    "MEMBERSHIP_TAG_DELETED",
      -    "MEMBERSHIP_TIER_UPSERTED",
      -    "MEMBERSHIP_TIER_DELETED",
      -    "COLLECTION_UPDATED",
      -    "CART_ABANDONED_1H",
      -    "CART_ABANDONED_24H",
      -    "CART_ABANDONED_72H"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / allowedTypes / type
      Removed value: -"array"
    • changedInput schema / properties / confirm / description
      Previous value: -"Explicit approval for this exact provider effect or local private-file operation."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / payload / properties / allowedTypes / $ref
      Added value: +"#/$defs/allowedTypes"
    • removedInput schema / properties / payload / properties / allowedTypes / items
      Removed value: -{
      -  "enum": [
      -    "ORDER_PLACED",
      -    "ORDER_UPDATED",
      -    "GIFT_PURCHASE",
      -    "PRODUCT_CREATED",
      -    "PRODUCT_UPDATED",
      -    "DONATION",
      -    "SUBSCRIPTION_PURCHASED",
      -    "SUBSCRIPTION_EXPIRED",
      -    "SUBSCRIPTION_CHANGED",
      -    "NEWSLETTER_SUBSCRIBED",
      -    "THANK_YOU_SENT",
      -    "GIFT_DRAW_STARTED",
      -    "GIFT_DRAW_ENDED",
      -    "PROMOTION_CREATED",
      -    "PROMOTION_UPDATED",
      -    "PROMOTION_STATUS_CHANGED",
      -    "PLATFORM_APP_DISCONNECTED",
      -    "MEMBERSHIP_POST_UPSERTED",
      -    "MEMBERSHIP_SERIES_UPSERTED",
      -    "MEMBERSHIP_SERIES_DELETED",
      -    "MEMBERSHIP_TAG_CREATED",
      -    "MEMBERSHIP_TAG_UPDATED",
      -    "MEMBERSHIP_TAG_DELETED",
      -    "MEMBERSHIP_TIER_UPSERTED",
      -    "MEMBERSHIP_TIER_DELETED",
      -    "COLLECTION_UPDATED",
      -    "CART_ABANDONED_1H",
      -    "CART_ABANDONED_24H",
      -    "CART_ABANDONED_72H"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / properties / allowedTypes / type
      Removed value: -"array"
  2. First observedv2.0.0

TDQS

C2.3/5.0
Behavior3/5

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

The rate limit disclosure (100 requests / 10 seconds per shop) is genuine added value beyond the annotations. However, the description says nothing about the destructive nature of the update, whether omitted fields are preserved or cleared, or what confirmation semantics (the `confirm` parameter) mean in practice.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with no padding, and the rate limit is front-loaded. But the second sentence is pure tautology against the title, so half the content earns no place.

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

Completeness2/5

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

A destructive, non-idempotent mutation with 7 parameters, a nested payload object, and no output schema needs far more than a rate limit note. The description omits what is destroyed, how partial updates behave, and the exclusivity rules among the body parameters.

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 71%, so most parameters carry their own descriptions and the baseline is 3. The description adds nothing about the payload vs payload_file vs allowedTypes mutual-exclusion rules or the meaning of webhook_configuration_id.

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

Purpose2/5

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

The description says only "Update a webhook," which restates the tool name and title verbatim. It does not indicate what about a webhook can be updated (URL, event types) or distinguish this tool from create_webhook, delete_webhook, or get_webhook.

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

Usage Guidelines1/5

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

No guidance is given on when to use this tool versus the sibling create_webhook, delete_webhook, or get_webhook. There is no mention of prerequisites, confirmation requirements, or conditions under which updating is appropriate.

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

Deploy Server

Other Tools