BoomTown Metadata Parsing

WHAT IS IT?

BoomTown can import new leads from a variety of sources by processing emails. The import
process occurs when agents and brokers forward new lead emails to boomtown from the third
party lead sources they use. BoomTown will scrape the lead contact details from each email
and create a lead from those details in the BoomTown CRM.

To integrate with BoomTown the new lead emails need to match a specific format so that we
can capture and process their contact information. However, lead notification emails change
often, making them difficult to reliably grab information from.

That is where the Metadata format comes in. It can be added to any email, and is standardized
so that we can always parse it, despite what the rest of the email looks like.

HOW CAN I USE IT?

The Metadata format is defined at the site ​http://leadmetadata.org​, and is becoming a standard
in passing contact information through emails. Regardless of what the email looks like, meta
tags can be added that contain the basic information needed to create a lead in our system.
These tags will not be visible in the email, allowing you to format the rest of the email however
you would like without worrying about it being difficult to parse.

WHY SHOULD I USE IT?

Simply put, speed. Since the Metadata format is easily detectable and standardized, we trust it
to parse emails that contain metadata on its own. This basically means that even if we have
never seen that email format before, as long as it contains a valid metadata section we will
parse it automatically with no human interaction. This makes it faster than our source specific
parsers.

BOOMTOWN SPECIFICS

There are 2 things you should be aware of when sending Meta emails to BoomTown.

1. lead_type: ​When using this field, the only valid fields we accept are Buyer/Seller. There
is not currently a renter type in the BoomTown system. If you send “Renter” it will appear
as a buyer.
 2. lead_source: ​We maintain a large list of sources, however it is not all encompassing. If
you would like to be sure the source you are listing in this field is supported, it is best to
ask. Sources can easily be added, but if we are unable to match your source the created
lead’s source will be “UNKNOWN”

ADDITIONAL CUSTOM FIELDS

BoomTown also supports some additional custom fields that allow the passing of information
that isn’t critical to making a lead, but provides additional context or information.

1. lead_campaign:​ The campaign tag allows you to provide more information around the
source of a lead. If your source runs many different ad campaigns that generate leads
for an agent, you can send this in to differentiate which campaign created which lead.
This field’s value is limited to 50 alphanumeric characters.
2. Address by parts: B ​ oomTown provides an alternate way to store addresses in our
system in addition to the default ​lead_property_address​ tag. The difference between
the ​lead_property_address​ tag and the following group of 4 tags is how the data is
stored. The ​lead_property_address​ tag alone will add a note of the address, while the
following group of 4 will save the address as part of the lead that gets created. These
tags are also special in that all 4 must be present for any of them to be used to set
information for the lead. If any are missing or empty, nothing will be stored. For this
reason we suggest sending a l​ ead_property_address​ as well, even if you are planning
on using these.
a. lead_street: ​This field is used for setting the street address of a lead. It is limited
to 100 characters.
b. lead_city: ​This is used to set the city for a lead. It is limited to 50 characters.
c. lead_state:​ This is used for the abbreviated state or province of the lead. It is
limited to 2 alphabetic characters, which should correspond to a valid US State
abbreviation or Canadian Province abbreviation.
d. lead_zip:​ This is used for the zip or postal code of the lead. It is limited to 10
characters.

QUESTIONS

If you have any questions about this document please contact t​ ristan@boomtownroi.com​ and
mjenkins@boomtownroi.com