API Reference

Examples

Contact Form Example

Here is a sample HTTP POST request for a simple contact form. Subfields are separated by a single newline character.

URL encoded form data

KeyValue
FormID23534
Namefirst = John

last = Smith
Email[email protected]
Phone234-555-6789
Addressaddress = 1234 Test Drive

city = Test

state = IN

zip = 12345
UniqueID12345678

JSON

{
  "FormID": "23534",
  "Name": {
   "first": "John",
   "last": "Smith"
  },
  "Email": "[email protected]",
  "Phone": "234-555-6789",
  "Address": {
    "address": "1234 Test Drive",
    "city": "Test",
    "state": "IN",
    "zip": "12345"
  },
  "UniqueID": "12345678"
}

Contact Form Example with Field Types

Below is an example response when you have elected to send the field type with the rest of your webhook data. The FormID and UniqueID are internal submission fields and their format does not change.

URL encoded form data

KeyValue
FormID23534
Namefirst = John

last = Smith

field_type = name
Emailvalue = [email protected]

field_type = email
Phonevalue = 234-555-6789

field_type = phone
Addressaddress = 1234 Test Drive

city = Test

state = IN

zip = 12345

field_type = address
UniqueID12345678

JSON

{
  "FormID": "23534",
  "Name": {
    "first": "John",
    "last": "Smith",
    "field_type": "name"
  },
  "Email": {
    "value": "[email protected]",
    "field_type": "email"
  },
  "Phone": {
    "value": "234-555-6789",
    "field_type": "phone"
  },
  "Address": {
    "address": "1234 Test Drive",
    "city": "Test",
    "state": "IN",
    "zip": "12345",
    "field_type": "address"
  },
  "UniqueID": "12345678"
}