Webhooks

Webooks are currently available for Enterprise account plans. Click here to check your plan.

Webhooks are user-defined HTTP callbacks. More simply put, they're automated messages sent from an app to one or more destinations when something happens in that app.

Webhooks in Clive allow you to POST form submission data to one or more URLs for additional processing whenever a form is submitted. The message content is in JSON format and includes the submission date and time, the form values submitted, and information about the form itself and the visitor.

Here's an example message from a simple contact form:

{
  "formSubmission": {
    "id": "123",
    "context": {
      "time": "2021-07-07T15:16:32.897Z",
      "url": "https://www.example.com/contact-us.html",
      "geolocation": {
        "ip": "12.34.56.78",
        "state": "GA",
        "coordinates": {
          "latitude": 33.7893,
          "longitude": -84.3737
        },
        "city": "Atlanta",
        "country": "US"
      }
    },
    "applicationUrl": "https://app.clive.cloud/accounts/9999/submissions/123",
    "fieldValues": {
      "Name": [
        "Rose Gardener"
      ],
      "Email": [
        "rose.gardener@example.com"
      ]
    }
  },
  "form": {
    "id": "345",
    "name": "Contact Us",
    "applicationUrl": "https://app.clive.cloud/accounts/9999/forms/345"
  },
  "visitor": {
    "id": "678",
    "name": "Rose Gardener",
    "applicationUrl": "https://app.clive.cloud/accounts/9999/visitors/678"
  }
}

Webhooks in Clive are associated with individual forms. To create a webhook:

1. Visit the Forms area.
2. Select a form.
3. Click Webhooks.
4. Click Create a Webhook and configure the following fields:
   1. Webhook URL - this is the destination URL that the JSON data will be sent to.
   2. Description (optional) - a description of the webhook to help you identify it in Clive.

To test that Clive can successfully reach your destination URL, click the Test button next to the Webhook URL field. A success message will be displayed if the connection is successful. If not, an error message with the status code (such as a 404 "not found" error) will be displayed.

You can also check the status of existing webhooks in the Status column of the Webhooks screen. A checkmark indicates the most recent connection was successful, and an exclamation mark indicates a connection issue.

To see what your form submission data will look like for any given form:

1. Visit the Forms area.
2. Select a form.
3. Click Sample Webhook Content.