API_KEY
beehiiv_api_key
Developer setup
No fields declared in this snapshot.
User connection
- API Keygeneric_api_key · stringRequired
All integrations
BE
Catalogue metadata onlyemail newslettersv00000000_00
BEEHIIV
Beehiiv
Beehiiv is a newsletter platform for managing publications, subscribers, posts, automations, audience engagement, and monetization.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source 11
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
What setup is declared?
Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
API_KEY
Provider setup
Capability index
Actions and trigger definitions
Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.
Showing 1–11 of 11 actions
Create Draft Post
BEEHIIV_CREATE_DRAFT_POST
Create an unscheduled draft post from HTML content. This tool never confirms, publishes, schedules, or sends the post. Beehiiv creates posts asynchronously; the returned ID is stable while background creation finishes.
Untrusted display-only summary
Create Segment
BEEHIIV_CREATE_SEGMENT
Create an audience segment from explicit subscription IDs, explicit emails, or custom-field rules; returns the segment and its initial calculation status.
Untrusted display-only summary
Create Subscription
BEEHIIV_CREATE_SUBSCRIPTION
Create a new publication subscription without reactivating an unsubscribed address or sending a welcome email; supports attribution, initial custom fields, and newsletter-list assignment.
Untrusted display-only summary
List Custom Fields
BEEHIIV_LIST_CUSTOM_FIELDS
List the custom-field definitions available for subscriber metadata and dynamic audience segments in a publication, returning one page controlled by page and limit with pagination metadata for retrieving additional fields.
Untrusted display-only summary
List Posts
BEEHIIV_LIST_POSTS
Search a publication's posts by status, audience, channel, slug, tags, or author and optionally include content, recipients, or statistics.
Untrusted display-only summary
List Publications
BEEHIIV_LIST_PUBLICATIONS
List publications accessible to the API key, optionally including publication statistics; use the returned publication IDs with publication-scoped tools.
Untrusted display-only summary
List Segment Members
BEEHIIV_LIST_SEGMENT_MEMBERS
List full subscriber records currently included in an audience segment, optionally including stats, custom fields, referrals, tags, or premium tiers. The response contains subscriber PII.
Untrusted display-only summary
List Segments
BEEHIIV_LIST_SEGMENTS
List audience segments in a publication, filtered by segment type or calculation status, with optional latest statistics.
Untrusted display-only summary
List Subscriptions
BEEHIIV_LIST_SUBSCRIPTIONS
Search a publication's subscriptions by exact email or filter by status and tier, returning one cursor-controlled page of subscriber records.
Untrusted display-only summary
Update Draft Post
BEEHIIV_UPDATE_DRAFT_POST
Update content or presentation settings on an existing draft after verifying it is still a draft; refuses confirmed, archived, or sent posts and cannot publish or schedule.
Untrusted display-only summary
Update Subscription Custom Fields
BEEHIIV_UPDATE_SUBSCRIPTION_CUSTOM_FIELDS
Set or remove custom-field values on one subscription without changing its email, tier, billing link, or subscribed status.
Untrusted display-only summary
Provenance
Versioned facts, explicit trust.
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
- Repository
- https://github.com/provider-directoryHQ/provider-directory
- Commit
- 85e33f6a81dfe987f6fc3637d48d45052cea8ca5
- Generated
- 2026-09-12
- Trust policy
- untrusted_display_only
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.