How to load Convert Forms through EngageBox

In this article you will learn how to display a form created with Convert Forms in a popup using EngageBox.

1. Using Convert Forms shortcode

First of all, we need to find the shortcode of the Convert Form we're going to use. Let's see how to do that.

Navigate to Components > Convert Forms > Forms
While you are on the list view of your forms, find the form you are interested in and hover of the "chain-link icon" at the right of the forms row. See the screenshot below.

convert forms how to find shortcode

Now that we have the shortcode all that's left is to type that shortcode into our Engage Box editor like it is depicted in the screenshot below and save it! That's it!

engage box convert form shortcode

2. Using Convert Forms module

It is assumed that you have already published the module of the Convert Form you're interested in. If not, then first take a look at our How to display a form on the frontend documentation to learn exactly how to do that.

engage box convert form module

Using a module of Convert Forms inside an Engage Box does not differ in any way than any other conventional module. As seen in the screenshot above, just set the Box Type to Existing Module and right below select your Convert Forms module. That's it!

Auto-close popup after form submission

In case we'd like to auto-close the popup box after a successfull form submission, we'll need to use a small Javascript snippet which closes the popup 3 seconds after the "success" event of the form is fired.

Go to your box > Actions > Click on Add action > On Event and Action select After Open and Run Javascript respectively and enter the code below:

var form = me.el.querySelector(".convertforms");
form.addEventListener("success", function(event) {
	setTimeout(function() {
    	me.close();
    }, 3000);
});

The script above makes use of the Javascript Events API which is available for both Convert Forms and EngageBox extensions.

If you want to hide the popup as long as the session lasts and only after the form has been successfully submitted, place the following code into the Custom Code option in the Advanced tab of your popup.

EngageBox.onReady(function() {
	let popup = EngageBox.getInstance({eb.id});
	var form = popup.el.querySelector('.convertforms');
	form.addEventListener('success', (event) => {
		document.cookie = "engagebox_{eb.id}=true; path=/";
	});
});

If you would like to also auto-close the popup, use this snippet instead:

EngageBox.onReady(function() {
	let popup = EngageBox.getInstance({eb.id});
	var form = popup.el.querySelector('.convertforms');
	form.addEventListener('success', (event) => {
		document.cookie = "engagebox_{eb.id}=true; path=/";
		popup.close();
	});
});