This guide will provide necessary instruction for third-party services to send lead information directly to Lead Docket through the Opportunity API.
Some of these services include (but are not limited to):
- Website Forms
- Web Chat
- Answering Service
- Lead Generation Services
- Social Media Forms (Facebook)
- Etc...
See the following specialized integrations towards the bottom of this help article:
- Facebook Forms
- Google Forms
- Unbounce Forms
Traditional Integrations (Most Common)
To integrate directly with any third-party system/form, we will need the vendor to HTTP POST details about the form submission to an endpoint configured within Lead Docket (multipart/form-data - application/x-www-form-urlencoded).
Each system has their own way of sending the data but generally it would include separate items for First Name, Last Name, Email, Phone, and Lead Summary at the very least. The existing email that is already being sent should remain in place – this is in addition and should only be for new potential clients.
Here's an example of Lead Docket's default website form configuration:
Lead Docket's field names are notated in red for this example.
Endpoint: Website Form
Example Endpoint URL (multipart/form-data): https://[FIRMNAME].leaddocket.com/Opportunities/Form/68
- Field Name: First
- Lead Docket Display Name: First Name
- Data Type: text
- Field Name: Last
- Lead Docket Display Name: Last Name
- Data Type: text
- Field Name: Phone
- Lead Docket Display Name: Mobile Phone
- Data Type: text
- Field Name: Email
- Lead Docket Display Name: Email
- Data Type: text
- Field Name: Summary
- Lead Docket Display Name: Case Summary
- Data Type: text
Lead Docket's fields are completely configurable. Field names can be changed and additional fields can be added to match what is being sent.
Once the URL and mapping is configured, a test submission should be sent to ensure everything looks correct within Lead Docket.
When a test POST is sent through the endpoint, you should see one of the following:
- A successful submission will return the following json response: {"success":true,"opportunityId":[ID_OF_NEW_OPPORTUNITY]}
- A failed submission will return the following json response: {"success":false,"message":"[FAILURE_REASON]}
Specialized Integration Situations
- Facebook Forms
- Facebook cannot directly integrate with Lead Docket. However, Facebook Forms can be easily integrated using Zapier. A paid Zapier plan is required to use premium tools necessary for the integration (at least a "Starter" level account will suffice).
How to integrate Facebook Forms using Zapier:
- Create a new Zap
- Choose "Facebook Lead Ads" for Step 1 of the Zap
- Choose "New Lead" as the trigger event
- Sign into the Facebook account
- Generate a test to use for field mapping in the next step
- Choose "Webhooks by Zapier" for Step 2 of the Zap
- Select "POST" as the Action Event
- Paste the endpoint URL in the "URL" field
- In the "Data" section, populate the Lead Docket field names in the left-hand column and select the respective field from your Facebook Form test on the right-hand column
- Nothing else needs to be adjusted. Click continue and send a test - Lead Docket can confirm if everything came through correctly
- Turn Zap On
- Google Lead Forms
- Google sends information in the form of nested JSON, so a unique endpoint URL will be needed to pull apart the necessary information needed for field mapping.
- Google sends information in the form of nested JSON, so a unique endpoint URL will be needed to pull apart the necessary information needed for field mapping.
Example Google Lead Forms JSON:
{ "lead_id":"CKbai8W4xN4CFcoFrwkdyHEByw", "campaign_id":123456, "user_column_data": [ { "column_name":"Full Name", "string_value":"John Doe", "column_id": "FULL_NAME" }, { "column_name": "User Email", "string_value":"abc@xyz.com", "column_id":"EMAIL" }, { "column_name": "User Phone", "string_value":"+11234567890", "column_id":"PHONE_NUMBER" }, { "column_name": "Postal Code", "string_value":"94043", "column_id":"POSTAL_CODE" } ], "api_version":"1.0", "form_id":1234, }
Lead Docket will send the example data as follows:
lead_id : CKbai8W4xN4CFcoFrwkdyHEByw campaign_id : 123456 Full Name : John Doe User Email : abc@xyz.com User Phone : +11234567890 Postal Code : 94043 api_version : 1.0 form_id : 1234
- Unbounce Forms
- Since Unbounce sends information in JSON format, a unique endpoint URL must be provided.
- Here's an example URL for Unbounce: https://[FIRMNAME].leaddocket.com/Opportunities/FormJson/19?fieldname=data.json
- Since Unbounce sends information in JSON format, a unique endpoint URL must be provided.
Comments
0 comments
Please sign in to leave a comment.