Skip to main content
Glama
thenavidm

Beehiiv MCP Server

by thenavidm
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Create a webhook

create_webhook
Destructive

Create a Beehiiv webhook to send chosen publication events to a URL; confirm the action to update account state.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoThe webhook URL to send events to.
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.
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

A3.7/5.0
Behavior4/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 meaningful context beyond that: it mutates account state, needs an explicit confirm flag, and carries an OAuth scope requirement. It does not describe side effects like duplicate-webhook behavior, which keeps it below 5.

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 primary action front-loaded and no filler. The confirm sentence is slightly redundant with the schema description of confirm, but overall it is tight and well-ordered.

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 an 8-parameter mutation tool with nested payload variants and no output schema, the description covers the essential call prerequisites (state change, confirm, OAuth scope). Details like payload-vs-body-flag mutual exclusion are left to the schema, which is reasonable given high coverage.

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 url, account, confirm, payload, payload_file, and event_types. The description only touches the confirm flag ('requires confirm=true for the user-requested action'), adding little beyond the schema's own note that confirm should be true only when the user asked for exactly this action. Baseline 3 applies.

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 clear verb+resource ("Create a webhook") that an agent can distinguish from siblings like list_webhooks, get_webhook, update_webhook, and delete_webhook. It does not explicitly name those siblings or contrast scope, but the operation is unambiguous.

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?

Provides a real precondition (confirm=true for the user-requested action) and an auth requirement (webhooks:write for OAuth), which is useful when-to-use context. However, it gives no guidance on choosing this tool over alternatives or on when not to create a webhook.

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