View as Markdown
Beehiiv icon

Beehiiv ACTION

Create Subscriber

Create a new subscriber. See docs
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Beehiiv account once, then configure and run Create Subscriber from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "beehiiv-create-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    publicationId: "Publication Id",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Subscriber inputs
Property Type Description
email Email string
The email address of the subscriber.
Required
publicationId Publication Id string
The ID of the publication you want to subscribe to.
Required Dynamic
reactivateExisting Reactivate Existing boolean
Whether or not to reactivate the subscriber if they have already unsubscribed. This option should be used only if the subscriber is knowingly resubscribing. default: false.
Optional
sendWelcomeEmail Send Welcome Email boolean
Whether or not to send a welcome email to the subscriber. default: false.
Optional
utmSource UTM Source string
The source of the subscriber.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
beehiiv-create-subscriber
Version
0.0.5
App
Beehiiv
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes