1) Configure Beehiiv Fields

In order to pass fields from ViralSweep to Beehiiv, you will need to add them into Beehiiv first.

Login to Beehiiv and go to Audience > Custom Fields.
Click Create Custom Field.
Add the list of fields in the table below to your Beehiiv account.

Field Name	Data Type
vs_refer_link	Text
vs_auto_login_link	Text
vs_promo_id	Text
vs_refer_source_url	Text
vs_campaign_name	Text
vs_dob_date	Text
vs_country	Text
vs_zip	Text
vs_state	Text
vs_city	Text
vs_address2	Text
vs_address	Text
vs_phone	Text
vs_last_name	Text
vs_first_name	Text

2) Get Beehiiv Credentials

In order to get your API Key:

Login to Beehiiv.
Go to Settings > Integrations > API Keys.
Click the New API Key button, and then label your API Key ViralSweep so that you know what you're using it for.
Copy the API Key it generates for you.

3) Connect to Beehiiv

When setting up your promotion in ViralSweep, go to:

Integrations > Email & SMS.
Click Add Service > Beehiiv.

4) Complete the connection

To complete the connection within ViralSweep:

Paste your API Key into ViralSweep.
Decide if you want to have Beehiiv send the welcome email to each new user that signs up.

3. Click Connect.

4. A menu will appear with your Beehiiv publications. Choose a publication and click Connect.

5) You're connected

The promotion is now connected to Beehiiv and all entries will be sent into the connected publication.

FAQ

What fields do you pass to Beehiiv?
First Name
Last Name
Email Address
Address
Address 2
City
State
Postal Code
Country
Phone
Birthdate
Referral Link
Tracking Source
Promotion ID
Auto Login URL

How do I include these custom fields in my Beehiiv emails?
You simply use handlebar syntax to include custom fields within your Beehiiv emails.

For example, if you want to include the users first name, then in your email you would put:

Hi ###{{vs_first_name | beehiiv user}}

If you want to add the users referral link to your email, you would put:

###{{vs_refer_link}}

Do you update users information in Beehiiv?
Yes, if you run a promotion and we pass someone to Beehiiv, then you run another promotion in the future and the same person enters, we will automatically update their information in Beehiiv (if any new information is provided). Mainly, the referral URL and promotion ID will be updated with the newest information.

Do you resubscribe people if they unsubscribe from my Publication?
Yes, if someone unsubscribes from your Publication in Beehiiv, then they enter a ViralSweep promotion, we will pass them back into Beehiiv and they will once again be marked as "active".

Troubleshooting

If you have connected to Beehiiv and data is not being added to your list, these are the most common reasons as to why:

Missing fields
You did not add the custom fields to your Beehiiv account. Please see the top of the document to add these fields.

Email already in Beehiiv Publication
The email address entered into the promotion may already be in your Beehiiv Publication, so it will not be added again, though new information for that subscriber may be added.

Email already entered into ViralSweep
The email address entered into the promotion has already been entered into the promotion previously, so therefore it is not passed to Beehiiv. This can happen if you set up your Beehiiv integration after you have already entered the promotion.

User did not opt-in
The user did not click the link in the double opt-in confirmation email that was sent to them, or did not check off the opt-in checkbox on the ViralSweep form (if one was added). If they did not opt-in, they will not be added to your list.