WebHooks Add-On

  1. Introduction
  2. Install WebHooks add-on
  3. Create a WebHook
  4. Disable / Enable a WebHook
  5. Delete a WebHook
  6. Send data as JSON

Introduction

You can use the WebHooks Add-On to send data from your forms to any custom page or script you like. This page can perform integration tasks to transform, parse, manipulate and send your submission data to wherever you choose.

If you are developing an application that needs to be updated every time a form is submitted, WebHooks is for you. The advantage of WebHooks is that the passing of data is immediate and you can pass all submitted form data at once.

What's a WebHook?

A WebHook is just a push notification from Verso Forms to another server every time someone submits your forms.

What can you do with a WebHook?

WebHooks makes easier to integrate two systems. The most common use for a WebHook is to feed leads into your CRM. But there are lots of other things you could do as well.

What Do You Need?

The very nature of a WebHook assumes that you have some ability to write code (or bribe a friend or colleague who does). You need to have a server that can accept a POST request (the one you’d get from a form submission), and be able to write a script that does something in response.

Note: Verso Forms support the integration of multiples WebHooks by form.

Create a WebHook

To create a WebHook, you must perform the following steps:

  1. Go to the Add-Ons Manager and click on WebHooks.
  2. Click on the Create a Webhook button.
  3. A form used to configure the WebHook will appear:
    • Form: Select the form that will send notifications.
    • Handshake Key: This is a an optional key that you choose as an authentication mechanism to prevent spam to your Web Hook. This key will be included as a post parameter when our servers call yours. If you use this key, you should compare it to your copy to validate that the submission is legit.
    • Url: The URL where your script is located.
    • Status: Can be:
      • On: Send notifications
      • Off: Does not send notifications
    • Json: Can be:
      • On: Send data as JSON string
      • Off: Send data as Url Encoded string
    • Alias: Can be:
      • On: Send data with Field Alias as parameter key. Eg. Replaces 'text_0' by 'name'.
      • Off: Send data with Field ID as parameter key
    • Click Create.

Note: Select multiple forms to create the same WebHook for each form.

Disable / Enable a WebHook

To stop a webhook temporarily, you can choose to disable and enable later. To disable a form webhook, you must follow these steps:

  1. Go to the Add-Ons Manager and click on WebHooks.
  2. Click the Actions button of the WebHook to disable.
  3. Click Update.
  4. Change the Status from On to Off or vice versa.
  5. Click Update.

Delete a WebHook

To delete a WebHook, you must perform the following steps:

  1. Select the checkbox of the WebHook to delete.
  2. Click Bulk Actions.
  3. Click Delete.
  4. Then it will show a popup asking you to confirm your decision to delete the WebHook.

The WebHooks Manager will reload and the selected WebHook will be deleted.

Send data as JSON

To send the post data as a JSON string, you must follow these steps:

  1. Go to the Add-Ons Manager and click on WebHooks.
  2. Click the Actions button of the WebHook to disable.
  3. Click Update.
  4. Change the Json field from On to Off or vice versa.
  5. Click Update.