View as Markdown
Beehiiv icon

Beehiiv ACTION

List Custom Fields

Schema discovery — list all custom fields defined for subscribers in a publication. Use this before Create Subscriber or Update Subscriber to know what custom fields are available and their expected types. Use Get Publication Info to get the publication ID. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Beehiiv account once, then configure and run List Custom Fields 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-list-custom-fields",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    beehiiv: { authProvisionId: "apn_xxxxxxx" },
    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.

List Custom Fields inputs
Property Type Description
publicationId Publication ID string
The publication ID. Use Get Publication Info to find this.
Required

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-list-custom-fields
Version
0.0.2
App
Beehiiv
Authentication
API key
Read-only
Yes
Destructive
No
Open world
No