JSON-to-Email Webforms Follow
Through the power of Front Desk, Propertybase is able to capture leads from contact forms. There are several different methods Propertybase uses to accomplish this. In this article we will review, in detail, how to configure one of those methods: JSON-to-Email.
Note: Before you can use JSON-to-Email, you must enable Front Desk.
JSON-to-Email Overview
The concept of JSON-to-Email webforms is very simple. Your web form captures data from potential leads and sends that data in a specific JSON format to your unique Front Desk email address.
If the contents of the email are in a machine-readable format then FrontDesk is able to find the data in the email and process that data into Propertybase.
It's very important the data being sent to Front Desk follows the specified JSON format. The code below shows common supported JSON tags for both Contact and Inquiry objects.
Please note that JSON tags are case sensitive and there are no spaces in the tags.
Standard Contact JSON Tags
"Salutation":"Form Data" "FirstName":"Form Data"
"LastName":"Form Data" "Email":"Form Data" "Phone":"Form Data" "MobilePhone":"Form Data"
"LeadSource":"Form Data" "MailingStreet":"Form Data" "MailingCity":"Form Data" "MailingState":"Form Data'
"MailingPostalCode":"Form Data"
Note: Not all JSON tags are required, only Last Name.
Other Common Supported JSON Tags
We can support many other JSON tags, below is a list of common tags.
Data from the JSON tags can be mapped to any field on the Contact or Inquiry object. You will need to contact our support team and inform them of the API Names of the fields that you want the data mapped to.
"BathsMin":"Form Data"
"BedsMin":"Form Data"
"BedsMax":"Form Data"
"Budget":"Form Data"
"BuyingTimeframe":"Form Data"
"ContactPreference":"Form Data"
"ContactType":"Form Data"
"EmploymentStatus":"Form Data"
"InquirySource":"Form Data"
"InquiryURL":"Form Data"
"InterestedIn":"Form Data"
"Language":"Form Data"
"ListingId":"Form Data"
"LotSizeMin":"Form Data"
"LotSizeMax":"Form Data"
"Message":"Form Data"
"OwnerId":"Form Data"
"ParkingMin":"Form Data"
"ParkingMax":"Form Data"
"PriceMin":"Form Data"
"PriceMax":"Form Data"
"ProjectName":"Form Data"
"ProjectId":"Form Data"
"PropertyEnquiredAbout":"Form Data"
"PropertyType":"Form Data"
"ReasonForPurchase":"Form Data"
"RotationName":"Form Data"
"SellingTimeFrame":"Form Data"
"SizeMin":"Form Data"
"SizeMax":"Form Data"
"UtmCampaign":"Form Data"
"UtmContent":"Form Data"
"UtmMedium":"Form Data"
"UtmSource":"Form Data"
"UtmTerm":"Form Data"
The more data that you include in your email the more data that can be submitted to Propertybase. It is not required to have all these questions on your form for your customer, some of this data can be added to the email body when you build your email template.
Once the data is captured by FrontDesk it can be pushed to any field that you would like. You will have to contact our support team and inform them of the field API Names that you would like the data above populated to.
Custom Fields
The data captured can be sent to any field in Propertybase on the Contact or Inquiry objects.
If you have additional data that you would like to capture which is not listed in the common fields above then please contact the support team and they can assist you with adding support to additional JSON tags.
Our support team will need to verify that we are receiving the additional data in the correct format and will have to setup the correct mapping to your custom fields in FrontDesk.
After you send in a test record if something does not process correctly, let us know and we will adjust your mapping.
Always make sure you Grant Access, so we can verify.
Frequently Asked Questions
Does the fields have to be in a specific order?
No it does not matter, Inquiry and Contact fields can be mixed up. As the system will know where to start and stop grabbing the information for each field. For instance, it starts grabbing the last name data at "LastName" and ends at " after the data, it does not care about the order of the tags.
The processed data is not appearing in Propertybase?
Check the format of the JSON data and note the tags are Case Sensitive and do not contain spaces.
Contact the support team so that they can ensure that the data is mapped to the correct field in Propertybase. Please include a sample inquiry and the API Names of the fields that you would like the data mapped to. Also recommend that you Grant Support Access, so we can verify everything processes correctly.
Are the JSON tags case sensitive?
Yes the JSON tags are case sensitive and there should not be any spaces in the tags.
For instance the First Name and Last Name would be sent as per the below.
Incorrect
"first name":"John"
"last name":"Smith"
Correct
"FirstName":"John"
"LastName":"Smith"
Can I have spaces between the JSON tags and the data?
No the format does not support spaces between the JSON tags and the data.
Incorrect
"FirstName" : "John"
"LastName" : "Smith"
Correct
"FirstName":"John"
"LastName":"Smith"
Do I need to have a comer at the end of the line?
No it is not required.
Pure JSON code has a comer at the end of each line however our code reader does not require a comer at the end of the line. It will not cause any issues to the code reader if you have a comer at the end of each line of JSON.
Can I add additional data to the email that is not on the form?
Yes. It is common to add additional data to your email that is not on your form. For instance, you may want to write the Address of the Listing or Name of the Project so you know what the inquiry is about. You may also want to write the URL from the web form so that you can track where your leads are coming from.
How can I tell what website my form data came from?
We recommend adding the website URL to the data. This can be mapped to the InquiryUrl tag in the data.
"InquiryURL":"www.mywebsiteurl.com"
Can I add marketing UTM data to the email?
Yes. We recommend if you are doing digital marketing that you capture the UTM data from your marketing so that you can see what digital marketing is effective. This can be achieved by having the UTM data in the InquiryUrl or having the data mapped to separate UTM Tags. If possible we recommend mapping the data to separate UTM Tags
"UtmCampaign":"summer_sale"
"UtmContent":"video_ad"
"UtmMedium":"email"
"UtmSource":"newsletter"
"UtmTerm":"newyork_cupcakes"
For more information on how to use UTM parameters in your digital marketing please have look at this website.
https://blog.hootsuite.com/how-to-use-utm-parameters/
What if I can't send my emails using JSON?
JSON-to-Email only works if the email is formatted as JSON as this is a machine-readable format. If you are unable to send emails in the JSON format then please investigate other services such as FrontDesk Forms or WebToProspect API. Help Articles below.
Comments
0 comments
Please sign in to leave a comment.