How to connect Convert Forms with Zapier

Published in Convert Forms
Updated 09 Dec, 2020
The Convert Forms Zapier Integration is now stable! You can find it in Zapier's site at https://zapier.com/apps/convert-forms/integrations

Zapier allows you to instantly connect Convert Forms with 1,500+ apps to automate your work and find productivity super powers.

How it works

Convert Forms comes with a JSON-API which among other data exposes submissions to specific endpoints that can be read by 3rd party apps like Zapier. Using polling triggers, Zapier looks for new data at specified intervals (depending on your plan on Zapier) in order to pull new submissions and execute your Zaps.

Keep in mind that the Zapier addon doesn't have a bidirectional connection. Only Zapier can connect to your website and not vise versa.

Connect Zapier to Convert Forms

Convert Forms needs to be prepared to allow Zapier to connect to Convert Forms and retrieve its data. The steps listed below will help you set up Convert Forms.

Step 1: Enable JSON-API

Go to the Global Configuration > Convert Forms > Advanced Tab. Under this tab, you will see the Enable JSON-API. This option must be enabled.

convert-forms-enable-json-api

Step 2: Add an API Secret Key

Next, head over to the Security Tab. Within this tab, you will find the API Secret Key field that is used by Zapier for authentication. This must be an alphanumeric. No specials characters are allowed.

convert-forms-add-api-secret-key

Step 3: Connect Zapier to Convert Forms

Click on the link to get started. https://zapier.com/apps/convert-forms/integrations

On the redirected page you can select the App you want to use, in this case Convert Forms and set the Trigger Event > New Submission.

convert forms zapier create new zap

You can now click Continue to choose your account and get started.

convert forms zapier sign in

Now, you need to connect your account. Click on the Sign in to Convert Forms button. A new popup window will be opened and you'll be asked for an API Key and your website's URL (The one you've entered in the ConvertForms configuration page). Make sure you've entered your full website address starting with http://www.

convert-forms-allow-zapier

On the next screen you will be asked to select the ConvertForms Campaign you would like to connect. If you have successfully entered the correct API Key and website you will be able to see the list of your Campaigns. (If not, go back and check the API Key).

Select your campaign and click Continue

convert-forms-setup-zapier-lead

On the next screen click Fetch and Continue.

convert-forms-test-zapier

Zapier will try to fetch a lead from your website. If you see a green notification 'Test Successful!' you are set! Click on the Continue button now.

convert-forms-successful-zapier-test

Now that you've configured the communication between Zap and ConvertForms you need to add an Action Step for your Zap, like sending you back an e-mail whenever a lead is generated or syncing your leads with your favorite CRM app.

convert-forms-zapier-final-step

If you face any issues please create a support ticket.

Troubleshooting Zapier Connection

In some cases you may not be able to create your Zap or Zapier may suddenly stop working. Below we have a list of useful resources that should help you resolve the issue you are facing.

Ensure JSON API is enabled

Enable JSON API, found under Global Configuration > Convert Forms > Security, must be enabled for 3rd-party services such as Zapier, to be able to read your forms and submissions data.

Note that having this enabled does not mean that any 3rd-party service can read our Convert Forms data, a combination of JSON API and Secret Key must be present to be able to retrieve any data.

Ensure a Secret Key has been set correctly

Secret Key, found under Global Configuration > Convert Forms > Security, must be set and contain alphanumerics without any special characters.

This must be set by you. You will need to use it when you create your Zap, alongside Enable JSON API which are required in order for Zapier to be able to retrieve and sync your Convert Forms data with a 3rd-party service.

Ensure Convert Forms API endpoints return valid data

After setting the above options, you need to ensure the Convert Forms API return data. To do so follow the steps listed below:

  1. Get the Base URL of your site

    All the requests to the JSON API are of the type "GET" and they need to be sent to the following URL.

    http://www.example.com/index.php?option=com_ajax&format=raw&plugin=convertforms&task=api

    Replace http://www.example.com with the domain of your Joomla website.

  2. Try to get all your forms

    http://www.example.com/index.php?option=com_ajax&format=raw&plugin=convertforms&task=api&api_key={apikey}&endpoint=forms

    Replace {apikey} with your Secret Key you set above.

  3. If all the above endpoint returned your forms then the Convert Forms JSON API is enabled and works correctly. Zapier should be able to find your data and sync them with your favorite app.

You can find a complete documentation of the Convert Forms API, here: How to use the JSON API

Issues with Zaps

If you are having other problems with a Zap that you have created, we recommend contacting Zapier Support.

They are usually the best people to help you with any issues that you have within the Zapier dashboard, Zap configuration or behaviour.

Authentication Issues

The authentication process involves the Zapier service connecting to your Joomla site using your Convert Forms API Key and your site URL.

convert-forms-allow-zapier

Please ensure you complete the authentication correctly:

  • In the API Key field, enter the Secret Key you set under Global Configuration > Convert Forms > Security > Secret Key.
  • In the Website field, enter the URL to your Joomla site. Be sure the URL starts with https:// and do not include the trailing slash.

    For example: https://example.com.