Overview
The purpose of this document is to define the JSON payload for the LeadCreate and LeadUpdate webhook from Aimbase. The LeadCreate and LeadUpdate webhooks are separate webhooks, but they share a payload. LeadCreate will be triggered on creation of the lead. LeadUpdate will be triggered when there are changes to the payload sent for LeadCreate.
The LeadCreate and LeadUpdatewebhook is subscribed to from the Webhook API. Please see the Aimbase Webhook Subscribe Web Service Specification document for information about how to subscribe to the webhook. When subscribing to the webhook, a Data key/value pair collection can be given. This collection will be sent with each outgoing webhook payload.
LeadCreate and LeadUpdate payload is sent to the PostUrl via HTTP POST. The Content-Type HTTP header will be “application/json”. It is recommended that you verify that the source of the webhook post is Aimbase. This can be done by looking at the Authenticate header in the post. See the Aimbase Webhook Subscribe Web Service Specification document “Authenticating Webhooks” section for information about how to verify the Authenticate header in a webhook post.
It is expected that the PostUrl endpoint will respond to the request with a 200 (Ok) HTTP status code. If any other response is given, it is assumed that the request failed and then it will attempt retries. The request will be retried up to 3 times, after 20 seconds, 20 minutes, and 20 hours. If all retries fail, it will not attempt to send the request again.
Below is the list of properties that are in the POST body.
Lead Create and Update Payload Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The Lead record’s identifier. |
Data |
X |
Key/value pairs |
A collection of key/value pairs of data. This data is included from the Webhook subscription. |
Record |
X |
Record |
A record object that contains information about the lead’s prospect, dealer, company, and product information. |
Record Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The lead record’s identifier. |
LeadUid |
X |
GUID |
The lead record’s GUD. |
ExternalId |
|
|
The lead record’s external identifier for external systems (if available). |
Event |
|
|
The lead’s event name. |
Medium |
|
|
The medium of the web browsing data associated with the lead submission. |
Score |
X |
Number |
The lead score. |
ScoreText |
X |
|
The display text of the lead score. Values of greater than 100 are displayed as “100+” |
DealerDistance |
|
Number |
The distance (in meters) from the lead’s postal code to the dealer’s location. |
DealerDistanceMiles |
|
Decimal |
The distance (in miles) from the lead’s postal code to the dealer’s location. |
LeadDate |
X |
DateTime |
The time the lead was generated. |
ViewedDate |
|
DateTime |
The time the lead was first viewed by an assigned contact. |
StagingLeadId |
|
Number |
The identifier of the staging lead record that generated the lead. |
IsActive |
X |
Boolean |
Indicates if the lead is active or inactive. In the user interface, inactive leads are considered deleted and not visible. |
IsQualified |
X |
Boolean |
Indicates if the lead is qualified due to the lead’s score. |
FollowUpStatusCode |
X |
|
The follow up status of the lead (Contacted, Not Contacted) |
PurchaseStatusCode |
X |
|
The purchase status of the lead (Unknown, Considering, Purchased, Declined) |
ProspectInterestCode |
X |
|
The prospect interest status of the lead (Unknown, High, Moderate, Low, None) |
LeadTypeCode |
X |
|
The code of the lead’s type. |
| LeadTypeName | X | The name of the lead's type. | |
LeadCategoryCode |
X |
|
The code of the lead’s category. |
| LeadCategoryName | X | The name of the lead's category. | |
LeadSourceCode |
X |
|
The code of the lead’s source. |
| LeadSourceName | X | The name of the lead's source. | |
LeadCampaignCode |
|
|
The code of the lead’s campaign. |
| LeadStatusCode | The code of the lead's status. | ||
| ConditionCode | The code of the product condition on the lead - New (N), Used (U) or Showroom (S). | ||
CreateDate |
X |
DateTime |
The time the lead was created. |
UpdateDate |
|
DateTime |
The time the lead was last updated. |
Prospect |
X |
Prospect Data |
The prospect data associated with the lead. |
Dealer |
X |
Dealer Data |
The dealer data associated with the lead. |
Product |
X |
Product Data |
The product data associated with the lead. |
Company |
|
Company Data |
The company data associated with the lead. |
Customs |
|
Collection of Custom Data |
The custom data associated with the lead. |
Metadata |
|
Collection of Metadata Data |
The metadata associated with the lead. |
Prospect Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
|
The prospect record’s identifier. |
| ProspectAggregationId | X | The prospect record's aggregation identifier. | |
ProspectUid |
X |
GUID |
The prospect record’s GUID. |
ExternalId |
|
|
The prospect record’s external identifier for external systems (if available). |
LastName |
X |
|
The prospect’s last name. |
FirstName |
|
|
The prospect’s first name. |
Title |
|
|
The prospect’s title or salutation. |
Address1 |
|
|
The prospect’s mailing address line 1. |
Address2 |
|
|
The prospect’s mailing address line 2. |
City |
|
|
The prospect’s mailing address city. |
State |
|
|
The prospect’s mailing address state. |
PostalCode |
|
|
The prospect’s mailing address postal code. |
ZIP4 |
|
|
The prospect’s mailing address +4 zipcode numbers. |
CompanyName |
|
|
The name of the company the prospect works for. |
CompanyTitle |
|
|
The prospect’s job title at their company. |
County |
|
|
The prospect’s mailing address county. |
Country |
|
|
The prospect’s mailing address country name. |
CountryCode |
X |
|
The prospect’s mailing address country code (ISO 3166-1 alpha-2) |
HomePhone |
|
|
The home phone number of the prospect. |
WorkPhone |
|
|
The work phone number of the prospect. |
Fax |
|
|
The fax number of the prospect. |
|
|
The email address of the prospect. |
|
PhoneRefused |
X |
|
The prospect’s phone refused value. |
TextRefused |
X |
|
The prospect’s text refused value. |
MailRefused |
X |
|
The prospect’s mail refused value. |
EmailRefused |
X |
|
The prospect’s email refused value. |
FIPSCode |
|
|
The FIPS code of the prospect’s mailing address county. |
CensusCode |
|
|
The prospect’s census code value. |
MobilePhone |
|
|
The mobile phone number of the prospect. |
AddrStatus |
|
|
The prospect’s address status value. |
AddrError |
|
|
The prospect’s address error description value. |
LangCode |
|
|
The prospect’s language code (ISO 639-1) |
CassOverride |
|
|
The prospect’s cass override value. |
IsActive |
X |
Boolean |
Indicates if the prospect record is active or inactive. |
IsInvalidEmail |
X |
Boolean |
Indicates if the prospect’s email address is an incorrectly formatted email address. |
IsAddressCleaned |
X |
Boolean |
Indicates if the prospect’s mailing address has been cleaned by an address standardizing service. |
IsNurtured |
X |
Boolean |
Indicates if the prospect should receive nurture emails. |
Score |
X |
Number |
The prospect’s score value. |
ScoreText |
X |
|
The prospect’s score text value. If the prospect’s score is greater than 100, it will be displayed as “100+” |
| RollickScore | X | The rollick score based on the prospect aggregate score. | |
LegacyCustomerId |
|
Number |
The prospect’s legacy customer ID value. |
OriginProspectType |
X |
|
The original prospect type that was set on the prospect record when it was created. |
CurrentProspectType |
X |
|
The most up to date prospect type for the prospect. |
CompetitiveBrand |
|
|
The prospect’s competitive brand value. |
Latitude |
|
|
The latitude value of the prospect’s postal code. |
Longitude |
|
|
The longitude value of the prospect’s postal code. |
CreateDate |
X |
|
The time the prospect was created. |
UpdateDate |
|
|
The time the prospect was last updated. |
Customs |
|
Collection of Custom Data |
The custom data associated with the Prospect. |
Dealer Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The dealer record’s identifier. |
Name |
X |
|
The name of the dealer. |
MfgDealerNbr |
X |
|
The dealer’s number value that identifies the dealership. |
MfgDealerSubNbr |
|
|
The dealer’s sub-number or location value that identifies the sub-location of the dealership record. |
DealerNbr |
X |
|
The dealer’s full identifier, a combination of the MfgDealerNbr and MfgDealerSubNbr, separated by a dash (ex: 1001-1) |
Contact |
|
|
The public contact name at the dealership. |
|
|
The public email address of the dealership. |
|
EmailCC |
|
|
The public email cc address of the dealership. |
WebsiteUrl |
|
|
The URL of the marketing website for the dealership. |
Address1 |
|
|
The physical location address line 1 of the dealership. |
Address2 |
|
|
The physical location address line 2 of the dealership. |
City |
|
|
The physical location address city of the dealership. |
State |
|
|
The physical location address state of the dealership. |
PostalCode |
|
|
The physical location address postal code of the dealership. |
County |
|
|
The physical location address county of the dealership. |
CountryCode |
|
|
The physical location address country code of the dealership (ISO 3166-1 alpha-2) |
Phone |
|
|
The dealer’s public phone number. |
Fax |
|
|
The dealer’s public fax number. |
TollFree |
|
|
The dealer’s public toll free phone number (if different from the phone number). |
FIPSCode |
|
|
The physical location address FIPS code of the dealer’s county. |
CensusCode |
|
|
The census code value of the dealer. |
GeoResult |
|
|
The geo result value of the dealer. |
LangCode |
|
|
The dealer’s language code (ISO 639-1) |
IsActive |
X |
Boolean |
Indicates if the dealer record is active or inactive. |
IsPoorPerformer |
X |
Boolean |
Indicates if the dealer is a poor performing dealer. |
IsLeadHeld |
X |
Boolean |
Indicates if leads are held when assigned to the dealer. |
IsPsiDisabled |
X |
Boolean |
Indicates if no Prospect Satisfaction Index survey is sent for leads at this dealer. |
IsNurtureStreamDisabled |
X |
Boolean |
Indicates if leads that are assigned to this dealership are not sent nurture emails. |
ManufacturerCode |
X |
|
The code of the dealer’s manufacturer. |
DealerTypeCode |
X |
|
The dealer’s type code (S-Standard, D-Default) |
ContactPreferenceCode |
|
|
The dealer’s contact preference code (E-Mail, Unknown) |
ApplicationContextCode |
X |
|
The dealer’s application context code (B-Both, O-Owners only, S-Sales only, N-Neither). |
DealerGroupCode |
|
|
The dealer’s group code. |
SalespersonAssignmentTypeCode |
X |
|
The code of the dealer’s salesperson assignment type (Standard, Round Robin) |
Latitude |
|
|
The latitude location of the dealer’s physical address. |
Longitude |
|
|
The longitude location of the dealer’s physical location. |
CreateDate |
X |
DateTime |
The time the dealer record was created. |
UpdateDate |
|
DateTime |
The time the dealer record was last updated. |
Customs |
|
Collection of Custom Data |
The custom data associated with the dealer. |
Product Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The product record’s identifier. |
Name |
X |
|
The name of the product. |
BrandCode |
X |
|
The code of the product’s brand. |
BrandName |
X |
|
The name of the product’s brand |
ManufacturerPlantCode |
|
|
The code of the product’s source manufacturer plant that creates the product. |
ProductTypeCode |
|
|
The code of the product’s type. |
ProductTypeName |
|
|
The name of the product’s type.
|
SkuCode |
|
|
The code of the product’s SKU. |
Model |
|
|
The name of the product’s model. |
ModelYear |
X |
Number |
The model year of the product. |
Code |
X |
|
The code or external identifier of the product. |
DisplayOrder |
X |
Number |
The display order of the product when displayed in a list. |
IsActive |
X |
Boolean |
Indicates if the product record is active. |
ApplicationContextCode |
X |
|
The product’s application context code (B-Both, O-Owners only, S-Sales only, N-Neither). |
CreateDate |
X |
DateTime |
The time the product record was created. |
UpdateDate |
|
DateTime |
The time the product record was last updated. |
| ProductCategoryCode | The code of the product's category. | ||
| ProductCategoryName | The name of the product's category. | ||
| ProductCategoryFlattenedCode | The flattened product category code. | ||
| ProductCategoryFlattenedName | The flattened product category name. | ||
Customs |
|
Collection of Custom Data |
The custom data associated with the product. |
Company Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The company record’s identifier. |
CompanyUid |
X |
GUID |
The company record’s GUID. |
ExternalId |
|
|
The company record’s external identifier for external systems (if available). |
CompanyTypeCode |
X |
|
The code of the company’s type. |
ManufacturerCode |
X |
|
The code of the company’s manufacturer. |
DealerNbr |
X |
|
The dealer number of the company’s assigned dealer. |
Name |
X |
|
The company’s name. |
|
|
The public email address of the company. |
|
Address1 |
|
|
The mailing address line 1 of the company. |
Address2 |
|
|
The mailing address line 2 of the company. |
City |
|
|
The mailing address city of the company. |
State |
|
|
The mailing address state of the company. |
PostalCode |
|
|
The mailing address postal code of the company. |
County |
|
|
The mailing address county of the company. |
Country |
|
|
The mailing address country name of the company. |
FIPSCode |
|
|
The mailing address FIPS code of the company’s county. |
CountryCode |
|
|
The company’s mailing address country code (ISO 3166-1 alpha-2) |
Latitude |
|
|
The latitude location of the company’s mailing address. |
Longitude |
|
|
The longitude location of the company’s mailing address. |
Phone |
|
|
The company’s public phone number. |
MobilePhone |
|
|
The company’s public mobile phone number. |
Fax |
|
|
The company’s public fax number. |
Website |
|
|
The URL of the company’s public website. |
SicNumber |
|
|
The Standard Industrial Classification number of the company. |
SicCode |
|
|
The Standard Industrial Classification code of the company. |
SicDescription |
|
|
The Standard Industrial Classification description of the company. |
DunsSales |
|
|
The annual sales dollars of the company according to Dun & Bradstreet. |
DunsTotalGlobalEmployees |
|
|
The total number of global employees according to Dun & Bradstreet. |
DunsTotalEmployees |
|
|
The total number of domestic employees according to Dun & Bradstreet. |
LocationOwnershipTypeCode |
X |
|
The code of the company’s location ownership type. Indicates if they own or rent their location. |
DunsAnnualSalesVolume |
|
|
The annual sales volume of the company according to Dun & Bradstreet. |
ContactPreferenceCode |
|
|
The code of the company’s contact preference (E-Mail, Unknown) |
IsActive |
X |
Boolean |
Indicates if the company record is active. |
CreateDate |
X |
DateTime |
The time the company record was created. |
UpdateDate |
|
DateTime |
The time the company record was last updated. |
Customs |
|
Collection of Custom Data |
The custom data associated with the company. |
Custom Data Schema
Field Name |
Required |
Format |
Description |
FieldName |
X |
|
The name of the custom field. |
FieldValue |
X |
|
The value of the custom field. |
Metadata Data Schema
Field Name |
Required |
Format |
Description |
FieldName |
X |
|
The name of the metadata field. |
FieldValue |
X |
|
The value of the metadata field. |
Sample POST Content (JSON)
{
"Id": 77413,
"Data": {
"key1": "value1",
"key2": "value2"
},
"Record": {
"Id": 77413,
"LeadUid": "dcbdcc6a-143b-476d-8eda-c3d58c4c5411",
"ExternalId": null,
"Event": null,
"Medium": null,
"Score": 45,
"ScoreText": "45",
"DealerDistance": 1262793,
"DealerDistanceMiles": 784.662949203,
"LeadDate": "2020-11-18T10:27:29.577",
"ViewedDate": null,
"SentDate": null,
"StagingLeadId": 61803,
"IsActive": true,
"IsQualified": true,
"FollowUpStatusCode": "Not Contacted",
"PurchaseStatusCode": "Unknown",
"ProspectInterestCode": "Unknown",
"LeadTypeCode": "Request Quote",
"LeadTypeName": "Request Quote",
"LeadCategoryCode": "Website",
"LeadCategoryName": "Website",
"LeadSourceCode": "Manual Entry",
"LeadSourceName": "Manual Entry",
"LeadCampaignCode": null,
"LeadStatusCode": "Pending",
"CreateDate": "2020-11-18T10:29:30.86",
"UpdateDate": null,
"Prospect": {
"Id": 255585,
"ProspectAggregationId": 214355,
"ProspectUid": "a7d8c9bb-d19f-4c05-b33c-b575654158cc",
"ExternalId": null,
"LastName": "Doe",
"FirstName": "John",
"Title": null,
"Address1": "123 Road",
"Address2": null,
"City": null,
"State": "AZ",
"PostalCode": "78783",
"ZIP4": null,
"CompanyName": null,
"CompanyTitle": null,
"County": "Travis",
"Country": "United States",
"CountryCode": "US",
"HomePhone": "1118675399",
"WorkPhone": null,
"Fax": null,
"Email": "johndoe@example.com",
"PhoneRefused": false,
"TextRefused": false,
"MailRefused": false,
"EmailRefused": false,
"FIPSCode": null,
"CensusCode": null,
"CassCertified": null,
"MobilePhone": null,
"AddrStatus": null,
"AddrError": null,
"LangCode": null,
"CassOverride": null,
"IsActive": true,
"IsInvalidEmail": false,
"IsAddressCleaned": false,
"IsNurtured": true,
"Score": 200,
"ScoreText": "100+",
"RollickScore": null,
"LegacyCustomerId": null,
"OriginProspectType": "Website",
"CurrentProspectType": "Website",
"CompetitiveBrand": null,
"Latitude": 30.246407,
"Longitude": -97.766387,
"CreateDate": "2020-11-18T10:29:30.42",
"UpdateDate": null,
"Customs": []
},
"Dealer": {
"Id": 351,
"Name": "Dave's Dealer",
"MfgDealerNbr": "1234",
"MfgDealerSubNbr": null,
"DealerNbr": "1234",
"Contact": "Dave",
"EMail": "dave@dealer.com",
"EmailCC": null,
"WebsiteUrl": null,
"Address1": "123 Central Ave",
"Address2": null,
"City": "Pheonix",
"State": "AZ",
"PostalCode": "78783",
"County": null,
"Country": null,
"CountryCode": "US",
"Phone": "111-222-3333",
"Fax": null,
"TollFree": null,
"FIPSCode": null,
"CensusCode": null,
"GeoResult": null,
"LangCode": null,
"IsActive": true,
"IsPoorPerformer": false,
"IsLeadHeld": false,
"IsPsiDisabled": null,
"IsNurtureStreamDisabled": null,
"ManufacturerCode": "MFG01",
"DealerTypeCode": "S",
"ContactPreferenceCode": null,
"ApplicationContextCode": "B",
"DealerGroupCode": null,
"SalespersonAssignmentTypeCode": "Standard",
"Latitude": 29.889747,
"Longitude": -84.668835,
"CreateDate": "2015-07-14T10:56:59.58",
"UpdateDate": null,
"Customs": []
},
"Product": {
"Id": 1,
"Name": "Product 1",
"BrandCode": "BR01",
"BrandName": "Brand One",
"ManufacturerPlantCode": null,
"ProductTypeCode": null,
"ProductTypeName": null,
"SkuCode": null,
"Model": "Product 1",
"ModelYear": 2020,
"Code": "P01",
"DisplayOrder": 0,
"IsActive": true,
"ApplicationContextCode": "B",
"CreateDate": "2019-07-10T12:35:30.543",
"UpdateDate": null,
"ProductCategoryCode": "2426",
"ProductCategoryName": "24ft - 26ft 11in ",
"ProductCategoryFlattenedCode": "/OUT/FOB/2426/",
"ProductCategoryFlattenedName": "Outboard Boats / Outboard Boats / 24ft - 26ft 11in ",
"ProductCategoryId": 680,
"Customs": [
{
"FieldName": "Field1",
"FieldValue": "Field1Value"
},
{
"FieldName": "Field2",
"FieldValue": "Field2Value"
}
]
},
"Company": {
"Id": 12312,
"CompanyUid": "c317c1e5-4275-40f1-b78c-9c43f07857da",
"ExternalId": null,
"CompanyTypeCode": "CT1",
"ManufacturerCode": "MFG01",
"DealerNbr": "1234",
"Name": "ABC Inc.",
"Email": "abc@example.com",
"Address1": "967 Brownton Road",
"Address2": null,
"City": "Jackson",
"State": "MS",
"PostalCode": "39201",
"County": "Jackson",
"Country": "United States",
"FIPSCode": null,
"CountryCode": "US",
"Latitude": 32.198166,
"Longitude": -90.153015,
"Phone": "662-399-4388",
"MobilePhone": null,
"Fax": null,
"Website": "example.com",
"SicNumber": "1234",
"SicCode": "a1be1",
"SicDescription": "desc",
"DunsSales": "123",
"DunsTotalGlobalEmployees": 123,
"DunsTotalEmployees": 12,
"LocationOwnershipTypeCode": "Unknown",
"DunsAnnualSalesVolume": "125",
"ContactPreferenceCode": "INT",
"IsActive": true,
"CreateDate": "",
"UpdateDate": null,
"Customs": [
{
"FieldName": "Field1",
"FieldValue": "Field1Value"
},
{
"FieldName": "Field2",
"FieldValue": "Field2Value"
}
]
},
"Customs": [
{
"FieldName": "Field1",
"FieldValue": "Field1Value"
},
{
"FieldName": "Field2",
"FieldValue": "Field2Value"
}
],
"Metadata": [
{
"FieldName": "Metadata1",
"FieldValue": "Metadata1Value"
},
{
"FieldName": "Metadata2",
"FieldValue": "Metadata2Value"
}
]
}
}