JSON Spec and Field Definitions
RETR pushes loan officer contact(s) to your CRM via webhook using a JSON object, as defined below. It is highly recommended that you test your integration using a tool like Postman before using your export credits on your RETR CRM Carts.
Postman payload testing link: https://www.postman.com/lively-rocket-350714/workspace/retr-webhook-testing/request/23497644-202ed55e-cd73-4c9c-8f63-7eb524a54ce6?action=share&creator=23497644&ctx=documentation
JSON
{
"NMLSId": "123456",
"FirstName": "Stephen",
"LastName": "Loaner",
"FullName": "Stephen Loaner",
"Phone_Cell": "555-555-1212",
"Phone_Work": "555-555-9999",
"Email_Personal": "StephenLoaner@gmail.com",
"Email_Work": "StephenLoaner@retr.app",
"WebsiteURL": "https://www.StephensHomeLoansForYou.com",
"LinkedInURL": "https://www.linkedin.com/in/stephenloaner/",
"TwitterURL": "https://twitter.com/StephenLoanerMortgages",
"ZillowURL": "https://www.zillow.com/lender-profile/StephenLoanerMortgages",
"ExperienceURL": "https://www.experience.com/reviews/Stephen-Loaner",
"FacebookURL": "https://www.facebook.com/StephenLoanerMortgages",
"GoogleURL": "https://search.google.com/local/writereview?placeid=abc123",
"InstagramURL": "https://www.instagram.com/stephenloanermortgages",
"Company": "ACME Mortgage",
"Office_Address": "1234 Main St",
"Office_City": "Fairfax",
"Office_State": "VA",
"Office_Zip": "22033",
"CompanyNMLSId": "111111",
"BranchName": "ACME Mortgage - Fairfax Branch",
"BranchNMLSId": "999999",
"LoanCount_12Mo": 33,
"LoanVol_12Mo": 25975406,
"LoanCt_Conventional_12Mo": 22,
"LoanCt_VA_12Mo": 2,
"LoanCt_FHA_12Mo": 8,
"LoanCt_Other_12Mo": 1,
"LoanCt_LMI_12mo": 1,
"LoanVol_LMI_12mo": 345000,
"LoanCt_MMCT_12mo": 2,
"LoanVol_MMCT_12mo": 567890,
"IsManager": "Yes",
"LastLoanDate": "12/29/2023",
"LoanCount_3Mo": 5,
"LoanVolume_3Mo": 5200725,
"LastPurchase_LoanDate": "3/4/2022",
"LastPurchase_Address": "1007 Mountain Drive, Gotham, NJ 12345",
"LastPurchase_Buyer1": "Bruce Wayne",
"LastPurchase_Buyer2": "Selina Kyle",
"LastPurchase_Agent": "Stephen Loaner",
"LastPurchase_AgentCompany": "RETR Realty",
"LastPurchase_SalePrice": 8625000,
"LastPurchase_LoanAmount": 646875,
"Tags": "New Jersey, Top Producer",
"ListName": "New Jersey Loan Officers",
"Source": "RETR",
"RETRProfileURL": "https://retr.app/LoanOfficer/Profile/0",
"RETRLoId": 1,
"ExportDate": "2/18/2024"
}
Data Fields
| NMLSId | Unique NMLS Id for the contact |
| FirstName | First name |
| LastName | Last name |
| FullName | First name + Last name of contact |
| Phone_Cell | Mobile number |
| Phone_Work | Work number |
| Email_Personal | Personal email |
| Email_Work | Work email |
| WebsiteURL | Contact's website |
| LinkedInURL | Contact's LinkedIn profile |
| TwitterURL | Contact's Twitter profile |
| ZillowURL | Contact's Zillow profile |
| ExperienceURL | Contact's Experience profile |
| FacebookURL | Contact's Facebook profile |
| GoogleURL | Contact's Google profile |
| InstagramURL | Contact's Instagram URL |
| Company | Name of company where contact works. This is the parent company of the contact's branch where there is a branch defined for the contact |
| CompanyNMLSId | NMLS Id of the company where contact works |
| BranchName | Name of branch where contact works |
| BranchNMLSId | NMLS Id for branch |
| Office_Address | Contact's work address If branch is defined, this is the branch location. If branch is not defined, this is the company location. If contact is in multiple branches, this is usually the location of the oldest active location on file. |
| Office_City | Contact's work city If branch is defined, this is the branch location. If branch is not defined, this is the company location. If contact is in multiple branches, this is usually the location of the oldest active location on file. |
| Office_State | Contact's work state If branch is defined, this is the branch location. If branch is not defined, this is the company location. If contact is in multiple branches, this is usually the location of the oldest active location on file. |
| Office_Zip | Contact's work zip If branch is defined, this is the branch location. If branch is not defined, this is the company location. If contact is in multiple branches, this is usually the location of the oldest active location on file. |
| LoanCount_12Mo | Number of loans, in the 12 months preceding the ExportDate |
| LoanVol_12Mo | Loan volume, in the 12 months preceding the ExportDate |
| LoanCt_Conventional_12Mo | Number of Conventional loans, in the 12 months preceding the ExportDate |
| LoanCt_VA_12Mo | Number of VA loans, in the 12 months preceding the ExportDate |
| LoanCt_FHA_12Mo | Number of FHA loans, in the 12 months preceding the ExportDate |
| LoanCt_Other_12Mo | Number of Other loans, in the 12 months preceding the ExportDate |
| LoanCt_LMI_12mo | Number of loans in low or moderate income census tracts found for this contact's purchases, in the 12 months preceding the ExportDate |
| LoanVol_LMI_12mo | Loan volume in low or moderate income census tracts found for this contact's purchases, in the 12 months preceding the ExportDate |
| LoanCt_MMCT_12mo | Number of loans in majority minority census tracts found for this contact's purchases, in the 12 months preceding the ExportDate |
| LoanVol_MMCT_12mo | Loan volume in majority minority census tracts found for this contact's purchases, in the 12 months preceding the ExportDate |
| LastLoanDate | Date of most recent loan of any type found for this contact |
| LastPurchase_LoanDate | Date of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_Address | Property address of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_Buyer1 | Buyer 1 of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_Buyer2 | Buyer 2 of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_Agent | Buyer agent of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_AgentCompany | Buyer agent's company of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_SalePrice | Sale price of most recent loan found for this contact where there is a matching real estate transaction |
| LastPurchase_LoanAmount | Loan amount of most recent loan found for this contact where there is a matching real estate transaction |
| Source | RETR |
| Tags | Custom tags or labels for this contact separated by commas |
| ListName | The name of the list the contact was exported from (if applicable) |
| RETRLoId | UniqueLO Id for this LO contact |
| RETRProfileURL | URL to access this contact's profile on RETR |
| ExportDate | The date this date was exported. Useful for keeping track of how recent your data is. |