Introduction
This document provides guidance to 3rd parties developing an endpoint for Rollick to send lead data. The information below outlines the preferred authentication, required data points to capture, and a generic example post. Rollick will handle mapping the Rollick fields listed below to the fields in the 3rd party system.
Authentication
Rollick can handle multiple types of authentication. Below is a list of the preferred authentication types:
- Basic Authentication
- OAuth
- Token
Data Points
Below is a list of suggested data points (but not limited to) that can be sent to a 3rd parties system.
| Field | Required | Notes |
| Lead Date | X |
The date an individual submitted their lead information. |
| Lead Source |
|
Origin of the lead i.e. dealer website, etc. |
| Lead Type | X |
The type of information the lead is requesting i.e. contact a dealer, build a product, etc. |
| Lead Category | X |
This indicates where the lead came from i.e. .com, iPad, Third Party, etc. |
| First Name | X |
The lead's first name. |
| Last Name | X |
The lead's last name. |
| Address 1 |
|
The lead's address 1. |
| Address 2 |
|
The lead's address 2. |
| City |
|
The lead's city. |
| State |
|
State code or Province code. |
| Postal Code | X |
The lead's postal code. |
| Country Code | X |
ISO two-letter country codes. |
| Phone |
|
The phone number of the lead. |
| Brand | The OEM that makes the product. | |
| Make | X |
The specific category of products within an OEM. |
| Model | X |
The full name of the product |
| Year | X |
The model year of the product |
| Condition |
|
Identifies if the product is new or used. |
| Dealer Name |
|
Name of the dealership. |
| Dealer Identifier | X | CRM's internal Identifier for a dealer |
| Aimbase Identifier | X |
A lead sent by Rollick to a CRM provider will include the Aimbase Identifier i.e. aimbase_rollick-12345 This value could be passed in a specific field or within the comment/notes field. |
| Rollick Score | The rollick score based on the prospects aggregate score. | |
| Prequalification | Lead's prequalification detail of Pass/Fail | |
| Trade-In | Trade-In details - product brand, model, year, etc. | |
| Appointment | Lead's appointment details (day/time) for demo. | |
| Payment | Payment calculator details. | |
| Comment | The lead's comments |
Example Post
{
"LeadDate":"05/28/2024",
"LeadSource":"organic",
"LeadType":"contactdealer",
"LeadCategory":"wwww.oem.com",
"first_name":"Maggie",
"last_name":"Howell",
"address1":null,
"address2":null,
"city":null,
"state":"NM",
"postalcode":"87101",
"countrycode":"US",
"phone":"(547) 354-5171",
"brand":"Mongoose",
"make":"Switchback",
"model":"C GRX",
"year":"2024",
"condition":"New",
"dealername":"The Bike Barn",
"dealeridentfier":"6823OP",
"aimbaseidentfier":"aimbase_rollick-12345",
"rollickscore":"4",
"prequalification":"Pass",
"tradein":""{\"year\":\"2016\",\"make\":\"HARLEY-DAVIDSON\",\"model\":\"Dyna Glide\",\"usage\":\"8100\}",
"appointment":"{\"appointmentdate\":\"05/29/2024 10:00:00 AM\",\"comment\":\"Customer reached out looking to schedule a phone appointment with the dealership to go over some questions\",
"payment":"500",
"Comment":"I am looking for more infromation on the Switchback bicycle models.",
}