Using Heyflow's Integration

Heyflow have created a fantastic integration to LeadByte using our REST API. They have also got their own documentation created here.  

Step 1 - Create Administrator Key
Create your administrator key within LeadByte under Admin > Tech Hub > REST API.  This will need to be an Administrator Key.  Supplier Keys do not have the permission to READ Campaigns, which is what HeyFlow needs to detect (Read) your Campaigns and then create a lead.

Permissions:
Campaign: READ
Leads: CREATE

Step 2 - Add Account to your HeyFlow LeadByte Response Handler

To do this, you will need to have the following:

1. Your LeadByte API URL i.e. demo.leadbyte.co.uk
2. Your Administrator REST API Key

Scroll down on the "Response Handler" section until you find LeadByte.  Expand this section and click "Select Account". If this is your first time adding a LeadByte account to Heyflow, add a new account.  When you are connected you will be able to slect a Campaign to map your HeyFlow fields to LeadByte fields as per the image below.  

NOTE:  Ensure you have mapped the system labels on Heyflow in order for them to show on the integration screen above.  In order to do this:

1. Find the field on your form
2. Scroll down to the Labels and Variables option
3. Add your system label here

Make sure you test this setup once you've published your updates.

If you need to pass in an SID (Supplier) value against the funnel that is not dynamic then you should use the Static Text field option.  

Using Zapier
HF have an integration with Zapier which allows you to move data from Zapier into LeadByte.  You would use the New Response trigger in Zapier for Heyflow and the Submit a Lead action for LeadByte.  

Using HF redirects
In short, using redirects in HF you can post the registration data to a LB Campaign and use LB to redirect to a Thank You page.  Here follow the steps:

Step 1 - Set the Heyflow field variable
Add a variable to every Heyflow field. This should be the same as the field name in LeadByte. For example, if you ask a question "When do you consume electricity the most?", you may wish to set the field variable as "consumptionTime" and create that as a field in LeadByte.

Step 2 - Generate a LeadByte integration guide
You need to post data from Heyflow into LeadByte. This means you need to generate the API guide for the LB Campaign.  This requires access to our Classic API, ask support if you do not have it.  You need to replace the LeadByte tags with the Heyflow variables.
For example
LeadByte: &email=[email]&firstname=[firstname]
Updated for Heyflow: &email=@email&firstname=@firstname

Step 3 - Set the redirect in Heyflow
The use of a redirect enables you to post data from Heyflow into LeadByte. In the video example we are adding it behind the Submit URL.

Step 4 - Thank you page create and redirect
When a customer clicks submit, you need to post the data to LeadByte AND redirect the customer to a Thank you page. This means you need to have a Thank You page ready in Heyflow and update the redirects in LeadByte as per video.

IF you have any doubts or this articles seems outdated, please raise a support ticket.