1. Home
  2. Integrations
  3. Integrate with ConvertBox using webhooks

Integrate with ConvertBox using webhooks

In this short article we will show you how to setup a webhook inside ConvertBox to submit data to your app or custom integration.

If you are looking for our Zapier integration please see this article.

PLEASE NOTE

Due to the custom nature of webhooks this integration feature is for advanced users only. This documentation is provided under the assumption that you or your developer are experienced with working with custom webhooks.

Webhook data structure

Webhook notifications are sent via HTTP POST request, and the data will be formatted via JSON and resemble the example below:

{
  "first_name": "John",
  "last_name": "Smith"
  "email": "test-webhook@convertbox.com",
  "phone": "0123456789",
  "website": "mysite.com",
  "campaign_name": "My campaign name",
  "convertbox_name": "My ConvertBox name",
  "$referer": "http://mysite.com/signupurl",
}

Here is a breakdown of the data sent for all of our standard fields

  • first_name – The contacts first name.
  • last_name – The contacts last name (If given).
  • email – The visitors email address.
  • phone – The contacts phone number.
  • website – The visitors website url
  • $referer – The page url the contact was on when subscribing.
  • campaign_name – The name of the campaign submitted.
  • convertbox_name – The name of the ConvertBox submitted.

Working with custom fields
If you are using custom fields on your ConvertBox form they will be automatically sent to your webhook using the custom ID you set for the field.

 

How to setup your webhook with ConvertBox

Step 1

Edit your ConvertBox and select the form element you want to use webhooks with.

Then on the left sidebar select the Setup form actions button.

Step 2

Select the Add a new form action button.

Step 3

On the Use integration option select Webhooks then paste your webhook URL into the Webhook url field.

Now you can click the Send test button to send test data to your webhook URL for all the fields currently on your ConvertBox.

Wait for the test to send (usually take 1-3 seconds) and then click Add form action.

Step 4

Your new Webhook action will now appear in your list of actions for this form.

Click Done to close the Form actions modal and don’t forget to Save the changes to your ConvertBox in the editor.

 

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support