BenchmarkONE

Hatchbuck Integration StrategiesOverviewTerminologyHatchbuckContactClientWeb Tracking CookieClient SystemIntegration OptionsAPIsFormsStandard Form SubmissionHatchbuck Form Elements3rd Party Landing PageAJAX Dual Form SubmissionHand-off Dual Form SubmissionSystem-to-System Form SubmissionOverviewWhile Hatchbuck is excellent as a CRM and email marketing automation platform on its own, it becomes even more powerful when you obtain contact data and updates via integrations instead of purely manual entry. This document briefly covers the different strategies employed by Hatchbuck’s clients to integrate with the Hatchbuck system for programmatically sharing data with Hatchbuck.The solutions in this document cover a spectrum of flexibility and complexity from simple HTML editing to server application programming, some may not be relevant to your current situation.TerminologyHatchbuckIn this document, Hatchbuck refers to any of Hatchbuck’s web properties including app. and api..ContactA contact ultimately exists within the hatchbuck system and the only required piece of data to make it relevant is an email address or a name, ideally an email address will be available for the activities outlined below.ClientA subscriber to Hatchbuck’s system.Web Tracking CookiePlaced in the contact’s browser to enable web page tracking so you are able to see web page visits in a contact’s activity feed and trigger events based on those visits. Currently the only way to place a web tracking cookie in the contact’s browser is via a Hatchbuck form submission. Client SystemA system either owned by or controlled by a client of Hatchbuck where code or software changes may be implemented at the client’s discretion.Integration OptionsAPIsYou may query, insert and update contact data within the Hatchbuck system via API. If you have access to the appropriate server and development resources this is typically the most straight-forward and flexible option. The only current limitation in this solution is you will be unable to set the cookie for web page tracking in the user’s browsers.If you’d like to utilize our API’s that are currently in beta, please contact Hatchbuck support to obtain access and documentation.FormsWhile forms are less powerful than API’s, they are simpler to implement and currently provide the benefit of the web tracking cookie.Standard Form SubmissionHatchbuck provides a form builder where you enter fields, create a layout and receive different ways to embed your form. The simplest approach is a <script> tag embed but we also provide an HTML/CSS option where you may obtain the form’s source code for modifying and embedding into just about any platform. Whenever you choose the HTML/CSS option you will need to write your own Javascript validation routines for the form to prevent form submissions not including key data.This approach works for >90% of our clients’ needs.Hatchbuck Form ElementsWhen working with the HTML/CSS of a form you will need to maintain key elements for your own submission method to work. These are the form action, form id, each individual data field and the simple_spc field. If, after implementing your form into your system you make changes to the form design within Hatchbuck you’ll need to update the field names within your system to match what they are in Hatchbuck.<form id='hb-form' class='jotform-form' action='' method='post' name='form_32844106874' id='32844106874' accept-charset='utf-8'> <input type='hidden' name='formID' value='32844106874' /><div> <label id='label_1' for='input_1'>First Name</label> <input type='text' id='input_1' name='q1_control_fname' size='20' /></div><div> <label id='label_3' for='input_3'>Last Name</label> <input type='text' id='input_3' name='q3_control_lname' size='20' /></div><div> <label id='label_4' for='input_4'>E-mail<span class='form-required'>*</span></label> <input type='email' class='validate[required, Email]' id='input_4' name='q4_email' size='30' /></div><button id='input_2' type='submit' class='form-submit-button'>Submit Form</button><input type='hidden' id='simple_spc' name='simple_spc' value='32844106874-32844106874'/></form>3rd Party Landing PageThis is a variant of the standard form submission. Some of Hatchbuck’s clients have chosen to use a landing page system such as . Most 3rd party landing page builders allow you to drop in HTML code from another form system while allowing you to use their templates and designs. If you paste in the HTML/CSS code from the standard form submission approach, most systems will accept this code while allowing you to use their landing page builders and templates while still sending the data to Hatchbuck afterward. Additionally, as is the case with , this allows the cookie placement to execute.There are also various plugins for Wordpress and other content management platforms that allow you to put in the HTML/CSS code from 3rd party form systems and provide lightbox or different positioning functionality within Wordpress.AJAX Dual Form SubmissionDual form submission is for clients who wish to send data into two systems from a contact form submission. This approach allows you to do so while retaining the capability to drop the web tracking cookie in the contact’s browser.In the above diagram the contact is presented the HTML of a form from the client’s system. When the contact presses the submit button the client’s form page will contain code to trap the form submission event in Javascript. Within the form submission event an AJAX request can be made to the client system using a Javascript API such as JQuery. After the AJAX submission completes the form may resume a normal submission process and POST its data to the Hatchbuck system with a traditional browser transition.Because of cross-domain browser security you’re only allowed to send the AJAX data to a domain you control or that has authorized your submission via CORS. Please plan accordingly.Please reference the Hatchbuck Form Elements section regarding which fields must be passed on the POST to the Hatchbuck form processor.Hand-off Dual Form SubmissionThis is similar to the AJAX dual form submission but would be employed if you’re restricted by CORS. It requires custom code in the first submission response to generate redirect data for the second submission page. The key difference between this and the AJAX approach is the browser does a full POST to the client’s page which then writes back Javascript and HTML to the browser so it knows to POST again to a second location. This introduces an additional page transition (the client system redirect page) prior to the second POST to the Hatchbuck system but if the client system processing is quick it will not generally be noticed by users.System-to-System Form Submission (HTTP POST)This approach behaves exactly like an API call except it may be easier for a client to develop than a traditional API integration. This carries the same limitation of an API in that a web tracking cookie will not be placed on the user’s browser. We recommend using API’s over this approach however it is listed here for completeness since some Hatchbuck clients have implemented this solution.Using this approach the contact is never directly exposed to the Hatchbuck system just like in an API integration and all communication with Hatchbuck is handled by the client system will still adhering to the form specifications in the Hatchbuck Form Elements section. ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download