Accessing beehiiv API Key
Step 1: Log in to your beehiiv account and navigate to Settings, located in the bottom left corner of your screen.
Step 2: In the Settings menu, select API.
Step 3: Under the API Keys section, click on + Create New API Key.
Step 4: Give your API Key a unique name, then click Create New API Key.
Step 5: Copy the generated API Key immediately and store it in a secure location. Once you leave this page, the key will no longer be retrievable.
Connect beehiiv to your Interact App
Step 1: Turn on Lead Generation from the left sidebar in the Interact app builder.
Create your Opt-In Form by selecting the Contact Fields you want to collect from quiz takers.
Adjust your Form Settings to customize the opt-in experience.
Step 2: Scroll down to further customize your Opt-In Form, then click Save & Continue.
Step 3: Under Integrations, select beehiiv.
Step 4: Paste your beehiiv API Key in the pop-up window and click "Connect".
Step 5: Select your Beehiiv publication from the dropdown menu.
All leads collected from this quiz will be automatically added and subscribed to this publication.
Once done, click Save and Continue.
Important Note:
If you go back and change your publication, all lead generation settings associated with the previous publication will be reset.
You’ll need to reconfigure your other lead generation settings to match the new publication.
Map Interact Triggers to beehiiv Actions
Step 1: Under "Results," click the Add Action button.
For each quiz result, you'll set a Trigger and an Action.
When a quiz taker receives a specific quiz result, it will trigger the corresponding actions you've set.
Step 2: In the slide-out menu, select from the following Beehiiv actions:
Update Custom Field: Select a Beehiiv custom field to store quiz-related data. The field will auto-populate with the quiz result name, but you can customize it as needed.
Example: Map the "Quiz Result" field to automatically store the result each contact receives.
Add to Automation: Choose a Beehiiv automation from the dropdown to add new contacts to a specific automation.
Example: Assign different quiz results to different automation to send personalized emails based on a lead's result.
Step 3: Once you’ve set up a trigger/action for one quiz result, repeat the process for other results from the left sidebar.
After configuring all necessary triggers and actions, click Save & Continue.
Step 4: *Optional* You’ll be taken to the Answers section.
If desired, repeat Steps 1-3 to set a Trigger and Action for specific quiz answers. This allows you to trigger beehiiv actions when a quiz taker selects a particular answer.
If you prefer to skip this step, simply click Save & Continue.
Configure Beehiiv Integration Settings
Step 1: In the Beehiiv Settings section, configure the following options:
Reactivate Existing Subscribers: Choose whether to reactivate subscriptions for users who have previously unsubscribed. This option should only be used if the subscriber is intentionally resubscribing.
Send Welcome Email: Select whether or not to send a welcome email to new subscribers after they are added.
Step 2: Click Save and Continue.
Map Form Fields to beehiiv Subscriber Custom Fields
Step 1: Review how your opt-in form fields are mapped to beehiiv.
The Email field is pre-mapped and cannot be changed.
Step 2: For all other fields, choose the matching field from the dropdown that you would like to populate with the value in beehiiv.
Example: Map the "First Name" field to the corresponding custom field in Beehiiv.
Step 3: When you're done with mapping your form fields, please be sure to click Save & Continue.
Test your Connection to beehiiv
Step 1: Select Test Integration to test your Integration to beehiiv.
This will Send test contact information to your beehiiv account to test your integration setup.
Step 2: Once your test is successful, hit Publish on your quiz to start collecting leads.
Frequently Asked Question
What happens if I go back in and change my publication under Lead Generation for Beehiiv?
When you change your publication, all lead generation settings associated with the previous publication will be reset.
You’ll need to reconfigure your other lead generation settings to match the new publication.