View as Markdown
Beehiiv icon

Beehiiv ACTION

Add Subscriber

Create a new subscriber for a publication. Use List Custom Fields to discover available custom field names before passing customFields. Use Get Publication Info to get the publication ID. Set reactivateExisting: true to re-subscribe someone who previously unsubscribed. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Beehiiv account once, then configure and run Add 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-add-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    publicationId: "Publication ID",
    email: "Email",
  },
})

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.

Add Subscriber inputs
Property Type Description
publicationId Publication ID string
The publication ID. Use Get Publication Info to find this.
Required
email Email string
The email address of the new subscriber.
Required
reactivateExisting Reactivate Existing boolean
Whether to reactivate the subscriber if they previously unsubscribed. Only use if the subscriber is knowingly resubscribing. Default: false.
Optional
sendWelcomeEmail Send Welcome Email boolean
Whether to send a welcome email. Default: false.
Optional
utmSource UTM Source string
The source of the subscriber.
Optional
utmMedium UTM Medium string
The medium of the subscriber acquisition.
Optional
utmChannel UTM Channel string
The channel of the subscriber acquisition.
Optional
referringSite Referring Site string
The URL that referred the subscriber.
Optional
customFields Custom Fields string
JSON array of custom field name-value pairs. Example: [{"name": "role", "value": "Engineer"}]. Use List Custom Fields to discover available field names.
Optional
tier Tier string
Subscription tier. free for free tier, or the premium tier name.
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-add-subscriber
Version
0.0.2
App
Beehiiv
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes