Overview:
This integration provides one of the simplest ways to for you to import leads from your website into Supermove. This integrations relies on a flat JSON payloads from your website's lead form. It requires a moderate level of website administrative expertise to configure. For a more customizable integration for complex lead forms, please see the Developer API Integration page.
Prerequisites:
- Your website must be able to send a webhook (an automatic message) to our system. The message must include the lead information in valid JSON format with the header Content-Type: application/json.
How to Enable in Supermove:
- Go to Company Settings in Supermove
- Click Lead Providers Tab (see screenshot above)
- Click the + Add Lead Provider button.
- Select Standard Website from the list of known lead providers.
- Add a Name and Description for this connection.
- Note: You can configure multiple endpoints. The names and descriptions allow you tell them apart.
- Select the Project Type and Move Type from the dropdown menus. These will be used for all leads processed by this integration.
- Select Job and Project Tags. These will be added to all leads created by this integration.
- Click Copy URL. This URL is unique to your company and to your account.
- Send Payloads to the URL. All payloads sent to the endpoint will be associated with your Supermove account. No further API keys or organization identifiers are needed.
How to Debug Lead Processing:
Please see Debugging Inbound Leads - Link
Example JSON Payload:
{
"full_name": "John Smith",
"first_name": "John",
"last_name": "Smith",
"phone_number": "415-555-5555",
"email": "eric@test.com",
"size": "2 bedroom",
"date": "2024-07-26",
"additional_notes": "additional notes",
"referral_source": "Custom Website",
"referral_details": "URL: https://exampleurl.com/",
"origin_address": "8904 Chrysler Bend",
"origin_city": "Austin",
"origin_zip_code": "78744",
"origin_unit": "1",
"origin_floor_number": "2",
"origin_notes": "origin notes",
"origin_elevator": true,
"origin_long_walk": false,
"destination_address": "2717 South Lamar Blvd",
"destination_city": "Austin",
"destination_zip_code": "78704",
"destination_unit": "11",
"destination_floor_number": "3",
"destination_notes": "dest notes",
"destination_elevator": true,
"destination_long_walk": true,
"utm_content": "content_here",
"utm_medium": "medium_here",
"utm_source": "source_here",
"utm_term": "term_here",
"ad_click_id": "click_id",
"ad_cost": 250,
"ad_kind": "GOOGLE_ADS",
"is_test": false
}
Supported Fields:
Customer Information:
Property | Data Type | Description |
"full_name" | string | Conditionally Required - Either full_name or both first_name and last_name are required. If both combinations are omitted, the lead will be rejected. |
"first_name" | string | Conditionally Required - Either full_name or both first_name and last_name are required. If both combinations are omitted, the lead will be rejected. |
"last_name" | string | Conditionally Required - Either full_name or both first_name and last_name are required. If both combinations are omitted, the lead will be rejected. |
"phone_number" | string | Important - must conform to US/Canadian phone format. Must have be a 10 digit number and must have a valid 3 digit area code within the US or Canada. Payloads without these will be rejected. |
"email" | string | The Customer's email. |
Move Information:
Property | Data Type | Description |
"size" | string | Important - Must correspond to a value in your project size billing variable table! If it does not match the table, an error will be thrown. Can be omitted. |
"date" | string | expected format YYYY-MM-DD, integration will attempt to normalize this value from other formats. |
"additional_notes" | string | Free form string value. Any additional notes can be added here. |
"referral_source" | string | Used to track leads from specific providers, urls, etc. |
"referral_details" | string | Used to track details about the specific lead information. UTM parameters are often included here |
Location Information:
Property | Data Type | Description |
"origin_address" | string | Conditionally Required - Integration will default to Origin Zip Code if no address is provided. Please provide a default business address for the origin if no address is collected as part of your lead form. |
"origin_city" | string | The city of the origin address. |
"origin_zip_code" | string | Conditionally Required - Integration will default to the origin_address to the zip code if the address is omitted. |
"origin_unit" | string | Origin unit, if collected. |
"origin_floor_number" | integer | Origin floor number, if collected. |
"origin_notes" | string | Free form notes about the origin. |
"origin_elevator" | boolean | Must be true or false. |
"origin_long_walk" | boolean | Must be true or false. |
"destination_address" | string | Conditionally Required - Destination zip code or destination address is required if any destination values are provided. |
"destination_city" | string | The city of the destination address. |
"destination_zip_code" | string | Conditionally Required - Destination zip code or destination address is required if any destination values are provided. |
"destination_unit" | string | Destination unit, if collected. |
"destination_floor_number" | integer | Destination floor number, if collected. |
"destination_notes" | string | Free form notes about the destination. |
"destination_elevator" | boolean | Must be true or false. |
"destination_long_walk" | boolean | Must be true or false. |
Online Marketing Values:
Property | Data Type | Description |
"utm_content" | string | The UTM Content associated with this lead. |
"utm_medium" | string | The UTM Medium associated with this lead. |
"utm_source" | string | The UTM Source associated with this lead. |
"utm_term" | string | The UTM Term associated with this lead. |
"ad_click_id" | string | The Ad Click ID for this lead. |
"ad_cost" | integer | The cost of this lead. |
"ad_kind" | string | Important must be either "GOOGLE_ADS" or "FACEBOOK". Lead will be rejected if it is not one of these two allowed values. |
Supermove Specific Fields:
Property | Data Type | Description |
"is_test" | boolean | Must be true or false. Will default to false if no value is provided. |
Comments
0 comments
Please sign in to leave a comment.