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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "beehiiv-add-subscriber",
"configured_props": {
"beehiiv": { "authProvisionId": "apn_xxxxxxx" },
"publicationId": "Publication ID",
"email": "Email"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "beehiiv",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "beehiiv-add-subscriber",
arguments: {
publicationId: "Publication ID",
email: "Email",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗