First-party app
beehiiv

beehiiv

Manage beehiiv publications, posts, subscriptions and segments — the newsletter platform's core content and audience surface.

stable EmailMarketingContent Management

About

beehiiv ships in the w6w first-party pack. It declares 12 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.

App id
io.w6w.beehiiv
Version
0.1.0
Author
w6w
Licence
MIT
Categories
Email · Marketing · Content Management

Overview

beehiiv is a newsletter platform: publications hold posts (the emails/web pages sent to subscribers) and subscriptions (the subscriber list).

This app covers the surface a workflow actually automates: list and read publications; create, update, read, list and delete posts (including beehiiv’s asynchronous Send API creation flow); and create, read, list, update and look up (by email) subscriptions.

Deliberately left out: the Ad Network (beta, per the vendor’s own spec), bulk subscription actions, automations/journeys, newsletter lists, segments, custom fields, authors, polls, podcasts, premium tiers, complimentary access, condition sets, data-privacy deletion requests, email blasts, engagements, subscriber exports, the referral program, webhooks, post templates and publication fields, and every workspace-scoped (cross-publication) endpoint. See the README for why.

Build with beehiiv

Three routes to the same 12 actions. The Workflow tab is generated from beehiiv's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.

Create Post

post-create

Create a post (Max/Enterprise plans only). Creation is asynchronous — the returned id is stable, but use Get Post to confirm it finished building before reading its content.

Delete Post

post-delete

Delete a draft post permanently, or archive a confirmed one. Cannot be undone for a draft.

Get Post

post-get

Fetch a single post. A post created via Create Post may still be building in the background — check the `processing` output field before reading the rest.

List Posts

post-list

Retrieve all posts belonging to a specific publication.

Update Post

post-update

Update an existing post (Max/Enterprise plans only). Only given fields change.

Get Publication

publication-get

Retrieve a single publication.

List Publications

publication-list

Retrieve all publications associated with your API key.

Create Subscription

subscription-create

Create a new subscription for a publication.

Get Subscription

subscription-get

Retrieve a single subscription by its subscription ID.

Get Subscription by Email

subscription-get-by-email

Retrieve a single subscription by its subscriber's email address.

List Subscriptions

subscription-list

Retrieve all subscriptions belonging to a specific publication.

Update Subscription

subscription-update

Update an existing subscription. Only given fields change.

A workflow step names the app and the action, and the editor fills in the connection when you pick one. This is the Step shape from the workflow spec, carrying beehiiv's real ids.

{
  "manifestVersion": "2",
  "name": "beehiiv-example",
  "steps": [
    {
      "id": "post-create",
      "uses": {
        "app": "io.w6w.beehiiv",
        "action": "post-create",
        "connection": "conn_YOUR_CONNECTION_ID"
      },
      "with": {
        "publicationId": "<publicationId>",
        "title": "<title>"
      }
    }
  ]
}

Here are some of the things you can do

  • Create Post

    perform
    post-create
  • Get Post

    read
    post-get
  • List Posts

    read
    post-list
  • Update Post

    perform
    post-update
  • Get Publication

    read
    publication-get

+7 more actions available

Every app-specific value here is a blank you have to fill in. An app action is reached through the connection that authenticates it, so the address is a connection id, not the app id — and connections belong to your account, so a public page cannot know yours. Create one for beehiiv, then fill in the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the parameters that action declares. The call itself is real — the shape is transcribed from the studio's own snippet builder, which prints the same kind of blanks — but nothing in it is specific to beehiiv. The Workflow tab is where this app's real ids are.

Install
npm install @w6w/sdk
yarn add @w6w/sdk
pnpm add @w6w/sdk
deno add npm:@w6w/sdk
Code
import { W6wClient, isActionRun } from "@w6w/sdk";

// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();

const envelope = await client.run({
  urn: "conn_YOUR_CONNECTION_ID",
  action: "post-create",
  payload: {
    publicationId: "<value>",
    title: "<value>",
    // subtitle: "<value>",
    // bodyContent: "<value>",
    // blocks: "<value>",
    // postTemplateId: "<value>",
    // status: "<value>",
    // scheduledAt: "<value>",
    // customLinkTrackingEnabled: "<value>",
    // thumbnailImageUrl: "<value>",
    // contentTags: "<value>",
    // newsletterListId: "<value>",
    // utmSource: "<value>",
    // utmMedium: "<value>",
    // utmCampaign: "<value>",
    // emailSettings: "<value>",
    // webSettings: "<value>",
    // seoSettings: "<value>",
    // recipients: "<value>",
    // customFields: "<value>",
  },
});

if (isActionRun(envelope)) console.log(envelope.value);
Install the CLI
npm install -g @w6w/cli
CLI
w6w run conn_YOUR_CONNECTION_ID --action post-create --payload '{"publicationId":"<value>","title":"<value>"}'

Give an AI agent beehiiv — without giving it beehiiv's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.

One tool call
{
  "name": "w6w_invoke",
  "arguments": {
    "ref": "app:io.w6w.beehiiv#post-create",
    "input": {
      "publicationId": "<publicationId>",
      "title": "<title>"
    }
  }
}

Every tool names its target with a single ref. The app: form above doesn't name a connection at all — the host resolves which of the caller's beehiiv connections to sign with, and refuses rather than guesses when the answer is ambiguous.

What the agent gets

Credentials it can't read

The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.

A tool surface scoped to the caller

Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.

A durable workflow in one call

Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.

Health-aware discovery

beehiiv's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.

The MCP surface is part of the hosted platform. beehiiv itself is MIT, and the runtime that executes it is source-available (FSL).

Request MCP access

Health checks

beehiiv declares its own checks, so its health is a property of the app rather than something the host guesses at.

service

beehiiv platform status

Component status from www.beehiivstatus.com (status.beehiiv.com redirects here). Covers Publication websites, App Admin, the Public API, MCP, email sending/metrics, embed forms, and the SendGrid infrastructure beehiiv sends mail through.

quota

API rate-limit headroom

Not exposed: beehiiv's OpenAPI document names a 429 on every endpoint but documents no rate-limit header or account-usage endpoint, and none was observed live.