Skip to main content
Glama
thenavidm

Beehiiv MCP Server

by thenavidm
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Update webhook

update_webhook
Destructive

Update an existing Beehiiv webhook's description or event types for a publication, requiring explicit confirmation before applying account changes.

Instructions

Update webhook. Changes account state and requires confirm=true for the user-requested action. OAuth integrations require webhooks:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file.
descriptionNoA description of the webhook.
endpoint_idYesThe prefixed ID of the webhook object
event_typesNo
payload_fileNoLocal JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged.
publication_idYesThe prefixed ID of the publication object

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
+  "event_types": {
+    "description": "The types of events the webhook will receive.",
+    "items": {
+      "enum": [
+        "post.sent",
+        "post.updated",
+        "subscription.confirmed",
+        "subscription.created",
+        "subscription.downgraded",
+        "subscription.paused",
+        "subscription.resumed",
+        "subscription.tier.paused",
+        "subscription.tier.resumed",
+        "subscription.upgraded",
+        "subscription.tier.created",
+        "subscription.tier.deleted",
+        "subscription.deleted",
+        "newsletter_list_subscription.subscribed",
+        "newsletter_list_subscription.unsubscribed",
+        "newsletter_list_subscription.paused",
+        "newsletter_list_subscription.resumed",
+        "post.scheduled",
+        "survey.response_submitted",
+        "podcasts.episode.published",
+        "podcasts.episode.updated",
+        "podcasts.episode.archived",
+        "podcasts.episode.deleted",
+        "podcasts.private_feed.activated",
+        "podcasts.private_feed.access_revoked",
+        "podcasts.private_feed.deactivated"
+      ],
+      "title": "WebhookEventType",
+      "type": "string"
+    },
+    "type": "array"
+  }
+}
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for every account mutation. Confirms only the user-requested action."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / event_types / $ref
      Added value: +"#/$defs/event_types"
    • removedInput schema / properties / event_types / description
      Removed value: -"The types of events the webhook will receive."
    • removedInput schema / properties / event_types / items
      Removed value: -{
-  "enum": [
-    "post.sent",
-    "post.updated",
-    "subscription.confirmed",
-    "subscription.created",
-    "subscription.downgraded",
-    "subscription.paused",
-    "subscription.resumed",
-    "subscription.tier.paused",
-    "subscription.tier.resumed",
-    "subscription.upgraded",
-    "subscription.tier.created",
-    "subscription.tier.deleted",
-    "subscription.deleted",
-    "newsletter_list_subscription.subscribed",
-    "newsletter_list_subscription.unsubscribed",
-    "newsletter_list_subscription.paused",
-    "newsletter_list_subscription.resumed",
-    "post.scheduled",
-    "survey.response_submitted",
-    "podcasts.episode.published",
-    "podcasts.episode.updated",
-    "podcasts.episode.archived",
-    "podcasts.episode.deleted",
-    "podcasts.private_feed.activated",
-    "podcasts.private_feed.access_revoked",
-    "podcasts.private_feed.deactivated"
-  ],
-  "title": "WebhookEventType",
-  "type": "string"
-}
    • removedInput schema / properties / event_types / type
      Removed value: -"array"
    • addedInput schema / properties / payload / properties / event_types / $ref
      Added value: +"#/$defs/event_types"
    • removedInput schema / properties / payload / properties / event_types / description
      Removed value: -"The types of events the webhook will receive."
    • removedInput schema / properties / payload / properties / event_types / items
      Removed value: -{
-  "enum": [
-    "post.sent",
-    "post.updated",
-    "subscription.confirmed",
-    "subscription.created",
-    "subscription.downgraded",
-    "subscription.paused",
-    "subscription.resumed",
-    "subscription.tier.paused",
-    "subscription.tier.resumed",
-    "subscription.upgraded",
-    "subscription.tier.created",
-    "subscription.tier.deleted",
-    "subscription.deleted",
-    "newsletter_list_subscription.subscribed",
-    "newsletter_list_subscription.unsubscribed",
-    "newsletter_list_subscription.paused",
-    "newsletter_list_subscription.resumed",
-    "post.scheduled",
-    "survey.response_submitted",
-    "podcasts.episode.published",
-    "podcasts.episode.updated",
-    "podcasts.episode.archived",
-    "podcasts.episode.deleted",
-    "podcasts.private_feed.activated",
-    "podcasts.private_feed.access_revoked",
-    "podcasts.private_feed.deactivated"
-  ],
-  "title": "WebhookEventType",
-  "type": "string"
-}
    • removedInput schema / properties / payload / properties / event_types / type
      Removed value: -"array"
  2. First observedv2.0.0

TDQS

C2.9/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 openWorldHint=true, so the safety profile is covered. The description adds genuinely non-structured context — account state mutation, the confirm gate, and the webhooks:write OAuth scope. It does not disclose the destructive semantics that matter most here: whether event_types/description are full replacements or merges, and what happens to omitted fields.

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?

Three short sentences with the constraint information front-loaded and no filler. The opening "Update webhook." is pure restatement of the title and earns no place, but the rest is tight.

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?

For a destructive 8-parameter mutation with nested objects and no output schema, the description covers the auth and confirmation requirements adequately. It is still incomplete on the update semantics (replace vs merge for event_types) and on sibling routing, which is the main gap for an agent deciding how to call it.

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 88%, so the schema already documents all eight parameters, including the payload/payload_file mutual exclusion and the confirm semantics. The description adds nothing about parameters, so the baseline of 3 applies.

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?

"Update webhook" restates the tool name and title without naming a single updatable attribute (description, event_types) or the resource's scope. It gives no way to distinguish this from create_webhook, delete_webhook, or get_webhook beyond the generic verb. The remaining sentences describe prerequisites, not the purpose.

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?

It states a real prerequisite (confirm=true for a user-requested action) and the OAuth scope required (webhooks:write), which is more than most definitions offer. However, it gives no guidance on when to use this versus sibling mutation tools (create_webhook, delete_webhook, patch-style alternatives), so routing is left to inference.

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