beehiiv icon

beehiiv

Publish newsletters and manage subscribers in beehiiv.

11 triggers57 searches38 actionsPollingAuth: OAuth

AI-assisted documentation31 min read

This documentation is compiled from our integration source code, internal specs for beehiiv, its official API documentation and anonymized requests logs we collect from our support team[2].

Open beehiiv on WEXTL →

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]

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]
Integration requests 23 permissions:
identify:readpublications:readposts:readposts:writesubscriptions:readsubscriptions:writeautomations:readautomations:writecustom_fields:readcustom_fields:writesegments:readsegments:writetiers:readtiers:writepolls:readpodcasts:readnewsletter_lists:readnewsletter_lists:writecomplimentary_access:readcondition_sets:readdata_deletion:readdata_deletion:writereferral_program:read
  1. Log in to your WEXTL account, add the beehiiv node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your beehiiv account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. 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 →

Watch Automation EmailsTrigger
Output fields[3]
FieldType
IDtext
Automation Step IDtext
Subject Linetext
Preview Texttext
Statustext
First Sent Atnumber
Last Sent Atnumber
Created Atdate
Statsobject
Emailobject
Clicksarray
Watch Condition SetsTrigger
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Createddate
Updateddate
Purposetext
Watch Data Deletion RequestsTrigger
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Sourcetext
Requested Attext
Scheduled For Processing Attext
Completed Atdate
Created Atdate
Watch Email BlastsTrigger
Output fields[3]
FieldType
IDtext
Createddate
Last Sentdate
Statustext
Subject Linetext
Preview Texttext
Statsobject
Emailobject
Clicksarray
Contentobject
Emailobject
Watch Newsletter List SubscriptionsTrigger
Output fields[3]
FieldType
IDtext
Newsletter List IDtext
Subscription IDtext
Statustext
Subscribed Atnumber
Unsubscribed Atnumber
Created Atdate
Watch Newsletter ListsTrigger
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Statustext
Auto Subscribeboolean
Subscriber Countnumber
Created Atdate
Updated Atdate
Watch PodcastsTrigger
Output fields[3]
FieldType
IDtext
Createddate
Slugtext
Descriptiontext
Categoriesarray
Categorietext
Artwork URLtext
Statustext
Languagetext
Titletext
Authortext
Typetext
6other output fields
Watch PollsTrigger
Output fields[3]
FieldType
IDtext
Nametext
Questiontext
Descriptiontext
Poll Typetext
Statustext
Created Atdate
Poll Choicesarray
IDtext
Labeltext
Trivia Answertext
Statsobject
Completionsnumber
Vote Countsobject
Total Responsesnumber
1other output field
Watch PostsTrigger
Output fields[3]
FieldType
IDtext
Subtitletext
Titletext
Authorsarray
Authortext
Createddate
Statustext
Publish Datedate
Displayed Datedate
Split Testedboolean
Subject Linetext
Preview Texttext
20other output fields
Watch PublicationsTrigger
Output fields[3]
FieldType
IDtext
Nametext
Organization Nametext
Referral Program Enabledboolean
Createddate
Statsobject
Active Subscriptionstext
Active Premium Subscriptionstext
Active Free Subscriptionstext
Average Open Ratetext
Average Click Ratetext
Total Senttext
Total Unique Openedtext
Total Clickedtext
Watch SubscriptionsTrigger
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Createddate
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Get Account Ad Network Report SummaryAction
Input fields[3]
FieldType
Start_datetext
End_datetext
Output fields[3]
FieldType
Publication IDtext
Opensnumber
Verified Clicksnumber
Revenuetext
Odaobject
Opensnumber
Verified Clicksnumber
Revenuetext
Programmaticobject
Opensnumber
Verified Clicksnumber
Revenuetext
Get Ad Network Report SummaryAction
Input fields[3]
FieldType
PublicationRequired
choice
Start_datetext
End_datetext
Output fields[3]
FieldType
Publication IDtext
Opensnumber
Verified Clicksnumber
Revenuetext
Odaobject
Opensnumber
Verified Clicksnumber
Revenuetext
Programmaticobject
Opensnumber
Verified Clicksnumber
Revenuetext
Get Ad Network ReportsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Start_datetext
End_datetext
Limitnumber
Output fields[3]
FieldType
Publication IDtext
Post IDtext
Ad Link IDtext
Opensnumber
Verified Clicksnumber
Revenuetext
Is Programmaticboolean
Get Ad Offer AdvertisementsAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
Advertisementsarray
IDtext
Recommendedboolean
Nametext
Headlinetext
Descriptiontext
Kindtext
Sponsor Texttext
Texttext
Get Ad OffersAction
Input fields[3]
FieldType
PublicationRequired
choice
Requested_fromtext
Output fields[3]
FieldType
Offersarray
IDtext
Payout Modeltext
Payout Per Clicktext
Payout Per Milletext
Estimated Payouttext
Send Bydate
Campaignobject
Advertiserobject
Get Advertisement OpportunitiesSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Advertiser Nametext
Payout Ratetext
Advertisement Kindtext
Send By Window Start Atnumber
Send By Window End Atnumber
Get Aggregate StatsAction
Input fields[3]
FieldType
PublicationRequired
choice
Audiencechoice
Platformchoice
Statuschoice
Content_tagsarray
Content_tagstext
Authorsarray
Authorstext
Hidden_from_feedchoice
Output fields[3]
FieldType
Statsobject
Emailobject
Webobject
Clicksarray
Upgradesnumber
Get AuthorAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Typetext
Nametext
Biotext
Bio Image URLtext
Social Media Linksobject
Twitter Handletext
Facebook URLtext
Instagram URLtext
Linkedin URLtext
Youtube URLtext
Tiktok URLtext
Discord URLtext
Bluesky URLtext
RSS URLtext
Get AutomationAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Statustext
Nametext
Trigger Eventsarray
Trigger Eventtext
Descriptiontext
Statsobject
Journeysobject
Emailobject
Get Automation JourneyAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Automation IDtext
Subscription IDtext
Emailtext
Statustext
Started Atnumber
Completed Atnumber
Get Complimentary AccessAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Durationnumber
Time Unittext
Descriptiontext
Tier IDtext
Tierobject
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Pricesarray
Statsobject
Total Grantednumber
Active Grantednumber
Get Condition SetAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Creatednumber
Updatednumber
Purposetext
Statsobject
Active Subscriber Countnumber
Get Custom FieldAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Kindtext
Displaytext
Creatednumber
Optionsarray
Optiontext
Get Data Deletion RequestAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Sourcetext
Requested Attext
Scheduled For Processing Attext
Completed Attext
Created Attext
Get Email BlastAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Creatednumber
Last Sentnumber
Statustext
Subject Linetext
Preview Texttext
Statsobject
Emailobject
Clicksarray
Contentobject
Emailobject
Get Newsletter ListAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Statustext
Auto Subscribeboolean
Subscriber Countnumber
Created Atnumber
Updated Atnumber
Get Newsletter List SubscriptionAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Newsletter List IDtext
Subscription IDtext
Statustext
Subscribed Atnumber
Unsubscribed Atnumber
Created Atnumber
Get PodcastAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Creatednumber
Slugtext
Descriptiontext
Categoriesarray
Categorietext
Artwork URLtext
Statustext
Languagetext
Titletext
Authortext
Typetext
6other output fields
Get Podcast EpisodeAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Creatednumber
Updatednumber
Titletext
Slugtext
Publish Datenumber
Displayed Datenumber
Durationnumber
Descriptiontext
Show Notestext
Artwork URLtext
6other output fields
Get PollAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Nametext
Questiontext
Descriptiontext
Poll Typetext
Statustext
Created Atnumber
Poll Choicesarray
IDtext
Labeltext
Trivia Answertext
Statsobject
Completionsnumber
Vote Countsobject
Total Responsesnumber
1other output field
Get PostAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Premium_tiersarray
Output fields[3]
FieldType
IDtext
Subtitletext
Titletext
Authorsarray
Authortext
Creatednumber
Statustext
Publish Datenumber
Displayed Datenumber
Split Testedboolean
Subject Linetext
Preview Texttext
20other output fields
Get Post TemplatesSearch
Input fields[3]
FieldType
PublicationRequired
choice
Orderchoice
Order_bytext
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Get PublicationAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Output fields[3]
FieldType
IDtext
Nametext
Organization Nametext
Referral Program Enabledboolean
Creatednumber
Statsobject
Active Subscriptionstext
Active Premium Subscriptionstext
Active Free Subscriptionstext
Average Open Ratetext
Average Click Ratetext
Total Senttext
Total Unique Openedtext
Total Clickedtext
Get Publication EngagementsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Start_datetext
Number_of_daysnumber
Granularitychoice
Email_typechoice
Directionchoice
Limitnumber
Output fields[3]
FieldType
Datedate
Total Opensnumber
Unique Opensnumber
Total Clicksnumber
Total Verified Clicksnumber
Unique Clicksnumber
Unique Verified Clicksnumber
Get Publications by Subscription EmailAction
Input fields[3]
FieldType
EmailRequired
email
Expandarray
Get Referral ProgramSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Auto Fulfillboolean
Num Referralsnumber
Rewardobject
IDtext
Nametext
Descriptiontext
Image URLtext
Typetext
Get SegmentAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Nametext
Typetext
Last Calculatednumber
Total Resultsnumber
Statustext
Activeboolean
Statsobject
Open Ratenumber
Total Sentnumber
Percentage Premium Subscribersnumber
Percentage Subscribers With Referralsnumber
Unique Emails Clickednumber
Total Deliverednumber
Total Referralsnumber
Unsubscribed Ratenumber
Total Subscribersnumber
Clickthrough Ratenumber
Get Subscription by EmailAction
Input fields[3]
FieldType
PublicationRequired
choice
EmailRequired
email
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Get Subscription by IDAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Get Subscription by Subscriber IDAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Get Subscription JWT TokenAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
JWT Tokentext
Get Subscription UpdateAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
IDtext
Typetext
Paramstext
Statustext
Publication IDtext
Failure Reasontext
Completednumber
Creatednumber
Updatednumber
Error Logarray
Error Logtext
Get TierAction
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Active Subscriptionsnumber
Pricesarray
IDtext
Currencytext
Amount Centsnumber
Enabledboolean
Intervaltext
Denominatortext
CTAtext
Featuresarray
Get Workspace PermissionsAction

No fields documented.

List AuthorsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Nametext
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Nametext
Biotext
Bio Image URLurl
Social Media Linksobject
Twitter Handletext
Facebook URLurl
Instagram URLurl
Linkedin URLurl
Youtube URLurl
Tiktok URLurl
Discord URLurl
Bluesky URLurl
RSS URLurl
List Automation EmailsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Automation Step IDtext
Subject Linetext
Preview Texttext
Statustext
First Sent Atnumber
Last Sent Atdate
Created Atdate
Statsobject
Emailobject
Clicksarray
List Automation JourneysSearch
Input fields[3]
FieldType
PublicationRequired
choice
Statuschoice
Limitnumber
Output fields[3]
FieldType
IDtext
Automation IDtext
Subscription IDtext
Emailtext
Statustext
Started Atdate
Completed Atdate
List AutomationsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Limitnumber
Output fields[3]
FieldType
IDtext
Statustext
Nametext
Trigger Eventsarray
Trigger Eventtext
Descriptiontext
Statsobject
Journeysobject
Emailobject
List Complimentary AccessSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Limitnumber
Output fields[3]
FieldType
IDtext
Durationnumber
Time Unittext
Descriptiontext
Tier IDtext
Tierobject
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Pricesarray
Statsobject
Total Grantednumber
Active Grantednumber
List Condition SetsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Purposechoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Createddate
Updateddate
Purposetext
List Custom FieldsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Kindtext
Displaytext
Createddate
Optionsarray
Optiontext
List Data Deletion RequestsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Sourcetext
Requested Attext
Scheduled For Processing Attext
Completed Attext
Created Atdate
List Email BlastsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Statuschoice
Order_bychoice
Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Createddate
Last Sentdate
Statustext
Subject Linetext
Preview Texttext
Statsobject
Emailobject
Clicksarray
Contentobject
Emailobject
List Newsletter List SubscriptionsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Newsletter List IDtext
Subscription IDtext
Statustext
Subscribed Atnumber
Unsubscribed Atnumber
Created Atdate
List Newsletter ListsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Statustext
Auto Subscribeboolean
Subscriber Countnumber
Created Atdate
Updated Atdate
List Podcast EpisodesSearch
Input fields[3]
FieldType
PublicationRequired
choice
Statuschoice
Order_bychoice
Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Createddate
Updateddate
Titletext
Slugtext
Publish Datenumber
Displayed Datenumber
Durationnumber
Descriptiontext
Show Notestext
Artwork URLtext
6other output fields
List PodcastsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Statuschoice
Limitnumber
Output fields[3]
FieldType
IDtext
Createddate
Slugtext
Descriptiontext
Categoriesarray
Categorietext
Artwork URLtext
Statustext
Languagetext
Titletext
Authortext
Typetext
6other output fields
List Poll ResponsesSearch
Input fields[3]
FieldType
PublicationRequired
choice
Order_bychoice
Directionchoice
Expandarray
Expandtext
Post_idtext
Limitnumber
Output fields[3]
FieldType
IDtext
Subscription IDtext
Subscription Deletedboolean
Poll Choice IDtext
Poll Choice Labeltext
Created Atdate
Extended Feedbacktext
Post IDtext
Post Titletext
Post Publish Datenumber
List PollsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Order_bychoice
Directionchoice
Expandarray
Expandtext
Post_idtext
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Questiontext
Descriptiontext
Poll Typetext
Statustext
Created Atdate
Poll Choicesarray
IDtext
Labeltext
Trivia Answertext
Statsobject
Completionsnumber
Vote Countsobject
Total Responsesnumber
1other output field
List PostsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Audiencechoice
Platformchoice
Statuschoice
Content_tagsarray
Content_tagstext
Slugsarray
Slugstext
Authorsarray
Authorstext
Premium_tiersarray
Order_bychoice
Directionchoice
2other input fields
Output fields[3]
FieldType
IDtext
Subtitletext
Titletext
Authorsarray
Authortext
Createddate
Statustext
Publish Datedate
Displayed Datedate
Split Testedboolean
Subject Linetext
Preview Texttext
20other output fields
List PublicationsSearch
Input fields[3]
FieldType
Expandarray
Directionchoice
Order_bychoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Organization Nametext
Referral Program Enabledboolean
Createddate
Statsobject
Active Subscriptionstext
Active Premium Subscriptionstext
Active Free Subscriptionstext
Average Open Ratetext
Average Click Ratetext
Total Senttext
Total Unique Openedtext
Total Clickedtext
List Segment Subscriber IDsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
Subscription IDtext
List Segment SubscribersSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Limitnumber
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Createddate
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
List SegmentsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Typechoice
Statuschoice
Order_bychoice
Directionchoice
Expandarray
Expandtext
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Typetext
Last Calculatednumber
Total Resultsnumber
Statustext
Activeboolean
Statsobject
Open Ratenumber
Total Sentnumber
Percentage Premium Subscribersnumber
Percentage Subscribers With Referralsnumber
Unique Emails Clickednumber
Total Deliverednumber
Total Referralsnumber
Unsubscribed Ratenumber
Total Subscribersnumber
Clickthrough Ratenumber
List Subscription UpdatesSearch
Input fields[3]
FieldType
PublicationRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Paramstext
Statustext
Publication IDtext
Failure Reasontext
Completednumber
Createddate
Updateddate
Error Logarray
Error Logtext
List SubscriptionsSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Statuschoice
Tierchoice
Premium_tiersarray
Premium_tierstext
Premium_tier_idsarray
Premium_tier_idstext
Emailtext
Order_bychoice
Directionchoice
Creation_datetext
Limitnumber
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Createddate
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
List TiersSearch
Input fields[3]
FieldType
PublicationRequired
choice
Expandarray
Expandtext
Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Active Subscriptionsnumber
Pricesarray
IDtext
Currencytext
Amount Centsnumber
Enabledboolean
Intervaltext
Denominatortext
CTAtext
Featuresarray
Accept Ad OfferAction
Input fields[3]
FieldType
PublicationRequired
choice
Offer_idRequired
text
Advertisement_idRequired
text
Post_idRequired
text
Output fields[3]
FieldType
Offer IDtext
Opportunity IDtext
Advertisement IDtext
Post IDtext
Add Subscription TagAction
Input fields[3]
FieldType
PublicationRequired
choice
Tagsarray
Tagtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Add Subscription to an AutomationAction
Input fields[3]
FieldType
PublicationRequired
choice
Emailtext
Subscription_idtext
Double_opt_overridetext
Output fields[3]
FieldType
IDtext
Automation IDtext
Subscription IDtext
Emailtext
Statustext
Started Atnumber
Completed Atnumber
Bulk Create SubscriptionAction
Input fields[3]
FieldType
PublicationRequired
choice
SubscriptionsRequired
array
EmailRequired
text
Reactivate_existingboolean
Send_welcome_emailboolean
Utm_sourcetext
Utm_mediumtext
Utm_campaigntext
Utm_termtext
Utm_contenttext
Referring_sitetext
Referral_codetext
Output fields[3]
FieldType
Messagetext
Import IDtext
Create a TierAction
Input fields[3]
FieldType
PublicationRequired
choice
NameRequired
text
Descriptiontext
Prices_attributesarray
CurrencyRequired
choice
Amount_centsRequired
number
Enabledboolean
IntervalRequired
choice
Interval_displaytext
Ctatext
Featuresarray
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Active Subscriptionsnumber
Pricesarray
IDtext
Currencytext
Amount Centsnumber
Enabledboolean
Intervaltext
Denominatortext
CTAtext
Featuresarray
Create Custom FieldAction
Input fields[3]
FieldType
PublicationRequired
choice
KindRequired
choice
DisplayRequired
text
Output fields[3]
FieldType
IDtext
Kindtext
Displaytext
Creatednumber
Optionsarray
Optiontext
Create Data Deletion RequestAction
Input fields[3]
FieldType
PublicationRequired
choice
EmailRequired
text
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Sourcetext
Requested Attext
Scheduled For Processing Attext
Completed Attext
Created Attext
Create Newsletter ListAction
Input fields[3]
FieldType
PublicationRequired
choice
NameRequired
text
Descriptiontext
Slugtext
Auto_subscribeboolean
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Statustext
Auto Subscribeboolean
Subscriber Countnumber
Created Atnumber
Updated Atnumber
Create Newsletter List SubscriptionAction
Input fields[3]
FieldType
PublicationRequired
choice
Subscription_idtext
Emailtext
Output fields[3]
FieldType
IDtext
Newsletter List IDtext
Subscription IDtext
Statustext
Subscribed Atnumber
Unsubscribed Atnumber
Created Atnumber
Create PostAction
Input fields[3]
FieldType
PublicationRequired
choice
Blocksarray
Blocktext
Body_contenttext
TitleRequired
text
Subtitletext
Post_template_idtext
Statuschoice
Scheduled_atdate
Custom_link_tracking_enabledboolean
Email_capture_type_overridechoice
Override_scheduled_atdate
12other input fields
Output fields[3]
FieldType
IDtext
Preview URLtext
Create SegmentAction
Input fields[3]
FieldType
PublicationRequired
choice
NameRequired
text
InputRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Typetext
Last Calculatednumber
Total Resultsnumber
Statustext
Activeboolean
Statsobject
Open Ratenumber
Total Sentnumber
Percentage Premium Subscribersnumber
Percentage Subscribers With Referralsnumber
Unique Emails Clickednumber
Total Deliverednumber
Total Referralsnumber
Unsubscribed Ratenumber
Total Subscribersnumber
Clickthrough Ratenumber
Create SubscriptionAction
Input fields[3]
FieldType
PublicationRequired
choice
EmailRequired
text
Reactivate_existingboolean
Send_welcome_emailboolean
Utm_sourcetext
Utm_mediumtext
Utm_campaigntext
Utm_termtext
Utm_contenttext
Referring_sitetext
Referral_codetext
10other input fields
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Delete Custom FieldAction
Input fields[3]
FieldType
PublicationRequired
choice
Delete Newsletter ListAction
Input fields[3]
FieldType
PublicationRequired
choice
Delete PostAction
Input fields[3]
FieldType
PublicationRequired
choice
Delete SegmentAction
Input fields[3]
FieldType
PublicationRequired
choice
Delete SubscriptionAction
Input fields[3]
FieldType
PublicationRequired
choice
Generate Post Preview URLAction
Input fields[3]
FieldType
PublicationRequired
choice
Platformtext
Subscriber_typetext
Tier_idsarray
Subscriber_idtext
Output fields[3]
FieldType
Preview URLtext
Identify UserAction
Output fields[3]
FieldType
First Nametext
Last Nametext
Emailtext
Profile Picturetext
Identify WorkspaceAction
Output fields[3]
FieldType
IDtext
Nametext
Owner Emailtext
Make an Api Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Recalculate SegmentAction
Input fields[3]
FieldType
PublicationRequired
choice
Output fields[3]
FieldType
Messagetext
Send Test EmailAction
Input fields[3]
FieldType
PublicationRequired
choice
Recipient_emailsRequired
array
Recipient_emailtext
Output fields[3]
FieldType
Remaining Test Sendsnumber
Reset Atnumber
Update a TierAction
Input fields[3]
FieldType
PublicationRequired
choice
Nametext
Descriptiontext
Prices_attributesarray
IdRequired
choice
CurrencyRequired
choice
Amount_centsRequired
number
IntervalRequired
choice
Interval_displaytext
Ctatext
Featuresarray
Deleteboolean
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Active Subscriptionsnumber
Pricesarray
IDtext
Currencytext
Amount Centsnumber
Enabledboolean
Intervaltext
Denominatortext
CTAtext
Featuresarray
Update a TierAction
Input fields[3]
FieldType
PublicationRequired
choice
Nametext
Descriptiontext
Prices_attributesarray
IdRequired
choice
CurrencyRequired
choice
Amount_centsRequired
number
IntervalRequired
choice
Interval_displaytext
Ctatext
Featuresarray
Deleteboolean
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Descriptiontext
Statsobject
Active Subscriptionsnumber
Pricesarray
IDtext
Currencytext
Amount Centsnumber
Enabledboolean
Intervaltext
Denominatortext
CTAtext
Featuresarray
Update Custom FieldAction
Input fields[3]
FieldType
PublicationRequired
choice
Displaytext
Output fields[3]
FieldType
IDtext
Kindtext
Displaytext
Creatednumber
Optionsarray
Optiontext
Update Custom FieldAction
Input fields[3]
FieldType
PublicationRequired
choice
Displaytext
Output fields[3]
FieldType
IDtext
Kindtext
Displaytext
Creatednumber
Optionsarray
Optiontext
Update Newsletter ListAction
Input fields[3]
FieldType
PublicationRequired
choice
Nametext
Descriptiontext
Slugtext
Auto_subscribeboolean
Statuschoice
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Statustext
Auto Subscribeboolean
Subscriber Countnumber
Created Atnumber
Updated Atnumber
Update Newsletter List SubscriptionAction
Input fields[3]
FieldType
PublicationRequired
choice
Unsubscribeboolean
Output fields[3]
FieldType
IDtext
Newsletter List IDtext
Subscription IDtext
Statustext
Subscribed Atnumber
Unsubscribed Atnumber
Created Atnumber
Update Newsletter List Subscription by Subscription IDAction
Input fields[3]
FieldType
PublicationRequired
choice
Unsubscribeboolean
Output fields[3]
FieldType
IDtext
Newsletter List IDtext
Subscription IDtext
Statustext
Subscribed Atnumber
Unsubscribed Atnumber
Created Atnumber
Update PostAction
Input fields[3]
FieldType
PublicationRequired
choice
Content_merge_strategychoice
Blocksarray
Blocktext
Body_contenttext
Titletext
Subtitletext
Scheduled_atdate
Custom_link_tracking_enabledboolean
Email_capture_type_overridechoice
Override_scheduled_atdate
Social_sharechoice
11other input fields
Output fields[3]
FieldType
IDtext
Subtitletext
Titletext
Authorsarray
Authortext
Creatednumber
Statustext
Publish Datenumber
Displayed Datenumber
Split Testedboolean
Subject Linetext
Preview Texttext
20other output fields
Update Subscription by EmailAction
Input fields[3]
FieldType
PublicationRequired
choice
EmailRequired
email
Tierchoice
Premium_tier_idsarray
Premium_tier_idtext
Premium_tiersarray
Premium_tiertext
Stripe_customer_idtext
Unsubscribeboolean
Custom_fieldsarray
Nametext
Valuetext
Deleteboolean
Complimentary_gift_idtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Update Subscription by IDAction
Input fields[3]
FieldType
PublicationRequired
choice
Emailtext
Tierchoice
Premium_tier_idsarray
Premium_tier_idtext
Premium_tiersarray
Premium_tiertext
Stripe_customer_idtext
Unsubscribeboolean
Custom_fieldsarray
Nametext
Valuetext
Deleteboolean
Complimentary_gift_idtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Update Subscription by IDAction
Input fields[3]
FieldType
PublicationRequired
choice
Tierchoice
Premium_tier_idsarray
Premium_tier_idtext
Premium_tiersarray
Premium_tiertext
Emailtext
Stripe_customer_idtext
Unsubscribeboolean
Custom_fieldsarray
Nametext
Valuetext
Deleteboolean
Complimentary_gift_idtext
Output fields[3]
FieldType
IDtext
Emailemail
Statustext
Creatednumber
Subscription Tiertext
Subscription Premium Tier Namesarray
Subscription Premium Tier Nametext
UTM Sourcetext
UTM Mediumtext
UTM Channeltext
UTM Campaigntext
UTM Termtext
8other output fields
Update SubscriptionsAction
Input fields[3]
FieldType
PublicationRequired
choice
Subscriptionsarray
Subscription_idRequired
text
Tierchoice
Stripe_customer_idtext
Unsubscribeboolean
Custom_fieldsarray
Complimentary_gift_idtext
Output fields[3]
FieldType
Subscription Update IDtext
Update SubscriptionsAction
Input fields[3]
FieldType
PublicationRequired
choice
Subscriptionsarray
Subscription_idRequired
text
Tierchoice
Stripe_customer_idtext
Unsubscribeboolean
Custom_fieldsarray
Complimentary_gift_idtext
Output fields[3]
FieldType
Subscription Update IDtext
Update Subscriptions' StatusAction
Input fields[3]
FieldType
PublicationRequired
choice
Subscription_idsRequired
array
Subscription_idtext
New_statusRequired
text
Update Subscriptions' StatusAction
Input fields[3]
FieldType
PublicationRequired
choice
Subscription_idsRequired
array
Subscription_idtext
New_statusRequired
text

Look for beehiiv templates in the WEXTL template library.

Browse templates →
  1. WEXTL® beehiiv Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for beehiiv.
  4. WEXTL® visual workflow builder data.

Last updated: Aug 15, 2026 01:40