Requirements
beehiiv requires an active account and OAuth client credentials, granted by signing in with your account to connect — both are set up on its own site.[3]
Get your beehiiv credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
Your OAuth application Client ID (uid). Create an OAuth app in your workspace under Settings > Integrations > API.
[1] - Client SecretpasswordRequired
Your OAuth application Client Secret, issued alongside the Client ID when you create your OAuth app.
[1]
Connect beehiiv in WEXTL
- Log in to your WEXTL account, add the beehiiv node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your beehiiv account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
beehiiv node modules
The list below is a reference of every beehiiv node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every beehiiv node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch Automation EmailsTrigger
| Field | Type |
|---|---|
| ID | text |
| Automation Step ID | text |
| Subject Line | text |
| Preview Text | text |
| Status | text |
| First Sent At | number |
| Last Sent At | number |
| Created At | date |
| Stats | object |
| object | |
| Clicks | array |
Watch Condition SetsTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Created | date |
| Updated | date |
| Purpose | text |
Watch Data Deletion RequestsTrigger
| Field | Type |
|---|---|
| ID | text |
| text | |
| Status | text |
| Source | text |
| Requested At | text |
| Scheduled For Processing At | text |
| Completed At | date |
| Created At | date |
Watch Email BlastsTrigger
| Field | Type |
|---|---|
| ID | text |
| Created | date |
| Last Sent | date |
| Status | text |
| Subject Line | text |
| Preview Text | text |
| Stats | object |
| object | |
| Clicks | array |
| Content | object |
| object |
Watch Newsletter List SubscriptionsTrigger
| Field | Type |
|---|---|
| ID | text |
| Newsletter List ID | text |
| Subscription ID | text |
| Status | text |
| Subscribed At | number |
| Unsubscribed At | number |
| Created At | date |
Watch Newsletter ListsTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Description | text |
| Status | text |
| Auto Subscribe | boolean |
| Subscriber Count | number |
| Created At | date |
| Updated At | date |
Watch PodcastsTrigger
| Field | Type |
|---|---|
| ID | text |
| Created | date |
| Slug | text |
| Description | text |
| Categories | array |
| Categorie | text |
| Artwork URL | text |
| Status | text |
| Language | text |
| Title | text |
| Author | text |
| Type | text |
Watch PollsTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Question | text |
| Description | text |
| Poll Type | text |
| Status | text |
| Created At | date |
| Poll Choices | array |
| ID | text |
| Label | text |
| Trivia Answer | text |
| Stats | object |
| Completions | number |
| Vote Counts | object |
| Total Responses | number |
Watch PostsTrigger
| Field | Type |
|---|---|
| ID | text |
| Subtitle | text |
| Title | text |
| Authors | array |
| Author | text |
| Created | date |
| Status | text |
| Publish Date | date |
| Displayed Date | date |
| Split Tested | boolean |
| Subject Line | text |
| Preview Text | text |
Watch PublicationsTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Organization Name | text |
| Referral Program Enabled | boolean |
| Created | date |
| Stats | object |
| Active Subscriptions | text |
| Active Premium Subscriptions | text |
| Active Free Subscriptions | text |
| Average Open Rate | text |
| Average Click Rate | text |
| Total Sent | text |
| Total Unique Opened | text |
| Total Clicked | text |
Watch SubscriptionsTrigger
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | date |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Get Account Ad Network Report SummaryAction
Get Ad Network Report SummaryAction
Get Ad Network ReportsSearch
Get Ad Offer AdvertisementsAction
Get Ad OffersAction
Get Advertisement OpportunitiesSearch
Get Aggregate StatsAction
Get AuthorAction
Get AutomationAction
Get Automation JourneyAction
Get Complimentary AccessAction
Get Condition SetAction
Get Custom FieldAction
Get Data Deletion RequestAction
Get Email BlastAction
Get Newsletter ListAction
Get Newsletter List SubscriptionAction
Get PodcastAction
Get Podcast EpisodeAction
Get PollAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Question | text |
| Description | text |
| Poll Type | text |
| Status | text |
| Created At | number |
| Poll Choices | array |
| ID | text |
| Label | text |
| Trivia Answer | text |
| Stats | object |
| Completions | number |
| Vote Counts | object |
| Total Responses | number |
Get PostAction
Get Post TemplatesSearch
Get PublicationAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Organization Name | text |
| Referral Program Enabled | boolean |
| Created | number |
| Stats | object |
| Active Subscriptions | text |
| Active Premium Subscriptions | text |
| Active Free Subscriptions | text |
| Average Open Rate | text |
| Average Click Rate | text |
| Total Sent | text |
| Total Unique Opened | text |
| Total Clicked | text |
Get Publication EngagementsSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Start_date | text |
| Number_of_days | number |
| Granularity | choice |
| Email_type | choice |
| Direction | choice |
| Limit | number |
| Field | Type |
|---|---|
| Date | date |
| Total Opens | number |
| Unique Opens | number |
| Total Clicks | number |
| Total Verified Clicks | number |
| Unique Clicks | number |
| Unique Verified Clicks | number |
Get Publications by Subscription EmailAction
| Field | Type |
|---|---|
EmailRequired | |
| Expand | array |
Get Referral ProgramSearch
Get SegmentAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Last Calculated | number |
| Total Results | number |
| Status | text |
| Active | boolean |
| Stats | object |
| Open Rate | number |
| Total Sent | number |
| Percentage Premium Subscribers | number |
| Percentage Subscribers With Referrals | number |
| Unique Emails Clicked | number |
| Total Delivered | number |
| Total Referrals | number |
| Unsubscribed Rate | number |
| Total Subscribers | number |
| Clickthrough Rate | number |
Get Subscription by EmailAction
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | |
| Expand | array |
| Expand | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Get Subscription by IDAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Get Subscription by Subscriber IDAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Get Subscription JWT TokenAction
Get Subscription UpdateAction
Get TierAction
Get Workspace PermissionsAction
No fields documented.
List AuthorsSearch
List Automation EmailsSearch
List Automation JourneysSearch
List AutomationsSearch
List Complimentary AccessSearch
List Condition SetsSearch
List Custom FieldsSearch
List Data Deletion RequestsSearch
List Email BlastsSearch
List Newsletter List SubscriptionsSearch
List Newsletter ListsSearch
List Podcast EpisodesSearch
List PodcastsSearch
List Poll ResponsesSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Order_by | choice |
| Direction | choice |
| Expand | array |
| Expand | text |
| Post_id | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Subscription ID | text |
| Subscription Deleted | boolean |
| Poll Choice ID | text |
| Poll Choice Label | text |
| Created At | date |
| Extended Feedback | text |
| Post ID | text |
| Post Title | text |
| Post Publish Date | number |
List PollsSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Order_by | choice |
| Direction | choice |
| Expand | array |
| Expand | text |
| Post_id | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Question | text |
| Description | text |
| Poll Type | text |
| Status | text |
| Created At | date |
| Poll Choices | array |
| ID | text |
| Label | text |
| Trivia Answer | text |
| Stats | object |
| Completions | number |
| Vote Counts | object |
| Total Responses | number |
List PostsSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Audience | choice |
| Platform | choice |
| Status | choice |
| Content_tags | array |
| Content_tags | text |
| Slugs | array |
| Slugs | text |
| Authors | array |
| Authors | text |
| Premium_tiers | array |
| Order_by | choice |
| Direction | choice |
| Field | Type |
|---|---|
| ID | text |
| Subtitle | text |
| Title | text |
| Authors | array |
| Author | text |
| Created | date |
| Status | text |
| Publish Date | date |
| Displayed Date | date |
| Split Tested | boolean |
| Subject Line | text |
| Preview Text | text |
List PublicationsSearch
| Field | Type |
|---|---|
| Expand | array |
| Direction | choice |
| Order_by | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Organization Name | text |
| Referral Program Enabled | boolean |
| Created | date |
| Stats | object |
| Active Subscriptions | text |
| Active Premium Subscriptions | text |
| Active Free Subscriptions | text |
| Average Open Rate | text |
| Average Click Rate | text |
| Total Sent | text |
| Total Unique Opened | text |
| Total Clicked | text |
List Segment Subscriber IDsSearch
List Segment SubscribersSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | date |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
List SegmentsSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Type | choice |
| Status | choice |
| Order_by | choice |
| Direction | choice |
| Expand | array |
| Expand | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Last Calculated | number |
| Total Results | number |
| Status | text |
| Active | boolean |
| Stats | object |
| Open Rate | number |
| Total Sent | number |
| Percentage Premium Subscribers | number |
| Percentage Subscribers With Referrals | number |
| Unique Emails Clicked | number |
| Total Delivered | number |
| Total Referrals | number |
| Unsubscribed Rate | number |
| Total Subscribers | number |
| Clickthrough Rate | number |
List Subscription UpdatesSearch
List SubscriptionsSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Status | choice |
| Tier | choice |
| Premium_tiers | array |
| Premium_tiers | text |
| Premium_tier_ids | array |
| Premium_tier_ids | text |
| text | |
| Order_by | choice |
| Direction | choice |
| Creation_date | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | date |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
List TiersSearch
| Field | Type |
|---|---|
PublicationRequired | choice |
| Expand | array |
| Expand | text |
| Direction | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Description | text |
| Stats | object |
| Active Subscriptions | number |
| Prices | array |
| ID | text |
| Currency | text |
| Amount Cents | number |
| Enabled | boolean |
| Interval | text |
| Denominator | text |
| CTA | text |
| Features | array |
Accept Ad OfferAction
Add Subscription TagAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Tags | array |
| Tag | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Add Subscription to an AutomationAction
Bulk Create SubscriptionAction
Create a TierAction
| Field | Type |
|---|---|
PublicationRequired | choice |
NameRequired | text |
| Description | text |
| Prices_attributes | array |
CurrencyRequired | choice |
Amount_centsRequired | number |
| Enabled | boolean |
IntervalRequired | choice |
| Interval_display | text |
| Cta | text |
| Features | array |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Description | text |
| Stats | object |
| Active Subscriptions | number |
| Prices | array |
| ID | text |
| Currency | text |
| Amount Cents | number |
| Enabled | boolean |
| Interval | text |
| Denominator | text |
| CTA | text |
| Features | array |
Create Custom FieldAction
Create Data Deletion RequestAction
Create Newsletter ListAction
Create Newsletter List SubscriptionAction
Create PostAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Blocks | array |
| Block | text |
| Body_content | text |
TitleRequired | text |
| Subtitle | text |
| Post_template_id | text |
| Status | choice |
| Scheduled_at | date |
| Custom_link_tracking_enabled | boolean |
| Email_capture_type_override | choice |
| Override_scheduled_at | date |
| Field | Type |
|---|---|
| ID | text |
| Preview URL | text |
Create SegmentAction
| Field | Type |
|---|---|
PublicationRequired | choice |
NameRequired | text |
InputRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Last Calculated | number |
| Total Results | number |
| Status | text |
| Active | boolean |
| Stats | object |
| Open Rate | number |
| Total Sent | number |
| Percentage Premium Subscribers | number |
| Percentage Subscribers With Referrals | number |
| Unique Emails Clicked | number |
| Total Delivered | number |
| Total Referrals | number |
| Unsubscribed Rate | number |
| Total Subscribers | number |
| Clickthrough Rate | number |
Create SubscriptionAction
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | text |
| Reactivate_existing | boolean |
| Send_welcome_email | boolean |
| Utm_source | text |
| Utm_medium | text |
| Utm_campaign | text |
| Utm_term | text |
| Utm_content | text |
| Referring_site | text |
| Referral_code | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Delete Custom FieldAction
| Field | Type |
|---|---|
PublicationRequired | choice |
Delete Newsletter ListAction
Delete PostAction
| Field | Type |
|---|---|
PublicationRequired | choice |
Delete SegmentAction
| Field | Type |
|---|---|
PublicationRequired | choice |
Delete SubscriptionAction
| Field | Type |
|---|---|
PublicationRequired | choice |
Generate Post Preview URLAction
Identify UserAction
| Field | Type |
|---|---|
| First Name | text |
| Last Name | text |
| text | |
| Profile Picture | text |
Identify WorkspaceAction
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Owner Email | text |
Make an Api Calluniversal
Recalculate SegmentAction
Send Test EmailAction
Update a TierAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Name | text |
| Description | text |
| Prices_attributes | array |
IdRequired | choice |
CurrencyRequired | choice |
Amount_centsRequired | number |
IntervalRequired | choice |
| Interval_display | text |
| Cta | text |
| Features | array |
| Delete | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Description | text |
| Stats | object |
| Active Subscriptions | number |
| Prices | array |
| ID | text |
| Currency | text |
| Amount Cents | number |
| Enabled | boolean |
| Interval | text |
| Denominator | text |
| CTA | text |
| Features | array |
Update a TierAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Name | text |
| Description | text |
| Prices_attributes | array |
IdRequired | choice |
CurrencyRequired | choice |
Amount_centsRequired | number |
IntervalRequired | choice |
| Interval_display | text |
| Cta | text |
| Features | array |
| Delete | boolean |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Description | text |
| Stats | object |
| Active Subscriptions | number |
| Prices | array |
| ID | text |
| Currency | text |
| Amount Cents | number |
| Enabled | boolean |
| Interval | text |
| Denominator | text |
| CTA | text |
| Features | array |
Update Custom FieldAction
Update Custom FieldAction
Update Newsletter ListAction
Update Newsletter List SubscriptionAction
Update Newsletter List Subscription by Subscription IDAction
Update PostAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Content_merge_strategy | choice |
| Blocks | array |
| Block | text |
| Body_content | text |
| Title | text |
| Subtitle | text |
| Scheduled_at | date |
| Custom_link_tracking_enabled | boolean |
| Email_capture_type_override | choice |
| Override_scheduled_at | date |
| Social_share | choice |
| Field | Type |
|---|---|
| ID | text |
| Subtitle | text |
| Title | text |
| Authors | array |
| Author | text |
| Created | number |
| Status | text |
| Publish Date | number |
| Displayed Date | number |
| Split Tested | boolean |
| Subject Line | text |
| Preview Text | text |
Update Subscription by EmailAction
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | |
| Tier | choice |
| Premium_tier_ids | array |
| Premium_tier_id | text |
| Premium_tiers | array |
| Premium_tier | text |
| Stripe_customer_id | text |
| Unsubscribe | boolean |
| Custom_fields | array |
| Name | text |
| Value | text |
| Delete | boolean |
| Complimentary_gift_id | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Update Subscription by IDAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| text | |
| Tier | choice |
| Premium_tier_ids | array |
| Premium_tier_id | text |
| Premium_tiers | array |
| Premium_tier | text |
| Stripe_customer_id | text |
| Unsubscribe | boolean |
| Custom_fields | array |
| Name | text |
| Value | text |
| Delete | boolean |
| Complimentary_gift_id | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Update Subscription by IDAction
| Field | Type |
|---|---|
PublicationRequired | choice |
| Tier | choice |
| Premium_tier_ids | array |
| Premium_tier_id | text |
| Premium_tiers | array |
| Premium_tier | text |
| text | |
| Stripe_customer_id | text |
| Unsubscribe | boolean |
| Custom_fields | array |
| Name | text |
| Value | text |
| Delete | boolean |
| Complimentary_gift_id | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | number |
| Subscription Tier | text |
| Subscription Premium Tier Names | array |
| Subscription Premium Tier Name | text |
| UTM Source | text |
| UTM Medium | text |
| UTM Channel | text |
| UTM Campaign | text |
| UTM Term | text |
Update SubscriptionsAction
Update SubscriptionsAction
Update Subscriptions' StatusAction
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscription_idsRequired | array |
| Subscription_id | text |
New_statusRequired | text |
Update Subscriptions' StatusAction
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscription_idsRequired | array |
| Subscription_id | text |
New_statusRequired | text |
Templates
Look for beehiiv templates in the WEXTL template library.
Browse templates →Explore alternative apps
- AWeber[2]Email marketing — lists, subscribers, campaigns, and broadcasts.
- AkeneoProduct information management (PIM) for enriching and distributing catalog data.
- BrandwatchConsumer intelligence and social listening platform for brand monitoring, insights, and research.
- BitlyShorten, retrieve, and manage Bitly links.
- Action NetworkManage people, events, petitions, signatures, and tags on Action Network.
References
- WEXTL® beehiiv Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for beehiiv.
- WEXTL® visual workflow builder data.
Last updated: Aug 15, 2026 01:40