Auth type: APIDocumentation Index
Fetch the complete documentation index at: https://hyperfx.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
For general setup steps, permissions, and troubleshooting, start with: App Integrations.
Connect Beehiiv
- Go to Settings → Apps in Hyper
- Select Beehiiv → Connect New
- Provide your Beehiiv API key
Common capabilities
- Automate newsletter workflows and email publishing
- Manage audience growth and subscriber lists
- Track newsletter performance and engagement
Use in Chat
Enable Beehiiv in the tool selector. Ask your agent to manage newsletters, check subscriber metrics, or draft content.Use in Agents
Add Beehiiv to an agent’s toolkits and select the connection. Mark sensitive actions (publish) as “requires approval.”Use in Flows
Automate newsletter publishing, audience management, and growth workflows using Beehiiv action nodes.Troubleshooting
- API errors: verify your API key and publication ID
- Publishing issues: check draft status and content formatting
Available Actions
Hyper agents can run the following actions for this integration. Each action can be individually set to Enabled, Requires Approval, or Disabled in your agent’s toolkit settings. Actions can be set to one of three control states:| State | Behavior |
|---|---|
| Enabled | Agent runs the action automatically |
| Requires Approval | Agent pauses and waits for your confirmation before proceeding |
| Disabled | Action is blocked and cannot be used |
| Action | Description |
|---|---|
| Add Tags | Add tags to a subscription for segmentation and organization |
| Add To Automation | Add a subscriber to an automation journey. The automation must have an ‘Add by API’ trigger |
| Create Custom Field | Create a new custom field for storing additional subscriber data |
| Create Post | Create and optionally publish a newsletter post |
| Create Segment | Create a new segment for grouping subscribers. Can be dynamic (rule-based) or manual (specific subscriber list) |
| Create Subscription | Create a new subscriber in a Beehiiv publication. Can optionally send welcome email and trigger automations |
| Create Tier | Create a new premium subscription tier with optional pricing |
| Delete Custom Field | Delete a custom field. This will remove the field from all subscribers |
| Delete Post | Delete/archive a post. This action cannot be undone |
| Delete Segment | Delete a segment. This action cannot be undone |
| Delete Subscription | Permanently delete a subscription. Use with caution - this action cannot be undone |
| Get Automation | Get details for a specific automation |
| Get Custom Field | Get details for a specific custom field |
| Get Post | Get details for a specific post including title, content, and optionally stats |
| Get Post Stats | Get aggregate statistics across all posts for a publication |
| Get Publication | Get details for a specific Beehiiv publication including name, stats, and referral program status |
| Get Referral Program | Get referral program details for a publication including milestones and rewards |
| Get Segment | Get details for a specific segment |
| Get Subscription | Get a specific subscription by ID or email address |
| Get Tier | Get details for a specific subscription tier |
| List Automation Journeys | List all journeys (subscriber progress) for an automation |
| List Automations | List all automations for a Beehiiv publication |
| List Custom Fields | List all custom fields defined for a publication |
| List Post Templates | List available post templates for a publication. Templates define styling that can be applied to new posts |
| List Posts | List posts for a Beehiiv publication. Filter by status, audience, or platform |
| List Publications | List all publications associated with the Beehiiv API key. Returns publication IDs, names, and optionally stats |
| List Segment Subscribers | List subscriber IDs belonging to a segment |
| List Segments | List all segments for a Beehiiv publication |
| List Subscriptions | List subscriptions for a Beehiiv publication. Filter by email, status, or tier |
| List Tiers | List all subscription tiers for a publication |
| Recalculate Segment | Trigger a recalculation of a segment’s subscribers |
| Update Custom Field | Update a custom field’s display name |
| Update Post | Update an existing post’s content, settings, or status. Can be used to publish a draft by setting status=‘confirmed’ |
| Update Subscription | Update a subscription’s tier, custom fields, or unsubscribe status |
| Update Tier | Update a premium subscription tier’s name, description, or pricing |