beehiiv

beehiiv is a newsletter platform designed to assist content creators and businesses in building, managing, and monetizing their newsletters with the beehiiv app in {{product name}} , you can manage subscribers, publications, posts, segments, automations, custom fields, tags, email blasts, and referral program in your beehiiv account requirements to use the beehiiv app in {{product name}} , you must have a beehiiv account connect beehiiv and {{product name}} to get started, you must first create a connection between beehiiv and {{product name}} , allowing the two services to communicate to create the connection, you need to beehiiv /#obtain your api key in beehiiv beehiiv /#obtain your publication id in beehiiv beehiiv /#create the connection in obtain your api key in beehiiv before you create the connection in {{product name}} , you should first obtain an api key in your beehiiv account to obtain the api key log in to your beehiiv account in the bottom left corner, click settings in the left sidebar, click api if you are prompted to verify your identity with stripe, click start stripe identity verification in the api keys section in beehiiv, click the create new api key button copy the api key value and store it in a safe place you'll use this value in the api key connection field in {{product name}} obtain your publication id in beehiiv before you create the connection in {{product name}} , you should first obtain a publication id in your beehiiv account to obtain the publication id log in to your beehiiv account in the bottom left corner, click settings in the left sidebar, click api in the publication id section, copy the publication id value under api v2 , and store it in a safe place you'll use this value in the publication id connection field in {{product name}} create the connection in {{product name}} once you have your beehiiv api key and publication id , you're ready to create the connection in {{product name}} to create the connection log in to your {{product name}} account, add a beehiiv module to your {{scenario singular lowercase}} , and click create a connection if you add a module with an ​instant​ tag, click ​ create a webhook ​​, then ​ create a connection ​​ optional in the ​​ connection name​​ field, enter a name for the connection in the ​​ api key field, enter the api key you copied from your beehiiv account in the publication id field, enter the publication id you copied from your beehiiv account click save if prompted, authenticate your account and confirm access you've successfully created the connection and can now use the beehiiv app in your {{scenario plural lowercase}} if you want to make changes to your connection in the future, follow the steps here https //help make com/connect an application#tn2pj set up a beehiiv webhook the beehiiv app has instant modules — webhooks that watch for certain changes in beehiiv and immediately start your {{scenario singular lowercase}} when those changes happen to use these modules, you must set up the webhook in your beehiiv account to set up the webhook add a beehiiv instant ​ module to your {{scenario singular lowercase}} and click create a webhook​ ​ optional enter a name for the webhook in the ​ webhook name​​ field click ​ save ​ > ​ copy address to clipboard ​​ you'll paste this address in your beehiiv account log in to your beehiiv account in the bottom left corner, click settings in the left sidebar, click webhooks in the endpoint url field, paste the webhook you copied above, and click continue select the required event types , and click create webhook your webhook is now set up when the selected change occurs in beehiiv , {{product name}} will immediately be notified and start your {{scenario singular lowercase}} beehiiv modules after connecting to the beehiiv app, you can use the following types of modules to build your {{scenario plural lowercase}} subscribers watch for subscribers watch for subscription confirmations watch for updates watch for unsubscribers watch for downgrades watch for survey form submission create a subscriber list all subscribers view a subscriber (via subscription id) view a subscriber (via email) view a subscriber (via subscriber id) update a subscriber batch update subscriber delete a subscriber publications list all publications view a publication posts watch for post sends list all posts view a post delete a post segments list all segments list a segment's members view a segment delete a segment automations add subscriber to an automation list all automations list all automation journeys view an automation view an automation journey custom fields create a custom field list all custom fields view a custom field update a custom field delete a custom field tags add tag to a subscriber email blasts list all email blasts view an email blast referral program view a referral program other make an api call beehiiv resources beehiiv api documentation