RETR Agent Data Specification: Webhook JSON Fields for CRM Integration
RETR sends real estate agent contacts to your customer relationship management (CRM) system through a webhook, as a JSON object. This article shows a sample JSON payload and explains each field RETR sends.
How does RETR send agent contacts to my CRM?
When you export agents from a RETR CRM Cart, RETR sends each agent contact to your CRM’s webhook URL as a JSON object. Each object includes the agent’s contact information and transaction and loan activity from the 12 months before the export date.
Can I test my webhook integration before using export credits?
Yes. We recommend testing your integration in Postman before you use export credits on your RETR CRM Carts. RETR provides a Postman workspace with a sample payload you can test with:
RETR Webhook Testing in Postman
JSON
{
"Owner": "RETR-Login-Email@email.com",
"FirstName": "John",
"LastName": "Doe",
"NickName": null,
"FullName": "John Doe",
"Company": "ACME Realty",
"RetrProfileURL": "https://retr.app/Agent/Profile/1",
"Email": "JohnDoe@retr.app",
"Phone": "555-555-1212",
"BuyerCt_12Mo": 180,
"BuyerVol_12Mo": 114014071,
"LoanOfficerCt_12Mo": 59,
"LoanCt_12Mo": 127,
"LoanCt_Conventional_12Mo": 66,
"LoanCt_VA_12Mo": 51,
"LoanCt_FHA_12Mo": 1,
"LoanCt_LMI_12Mo": 1,
"LoanVol_LMI_12Mo": 345000,
"LoanCt_MMCT_12Mo": 2,
"LoanVol_MMCT_12Mo": 567890,
"SellerCt_12Mo": 10,
"SellerVol_12Mo": 14014071,
"Source": "RETR",
"Tags": "Virginia",
"ListName": "Virginia Agents",
"RETRAgentId": 1,
"ExportDate": "2/17/2024"
}
Agent Contact Fields
| Field | Description |
|---|---|
| Owner | Email address of the RETR user who sent the data |
| FirstName | Agent’s first name |
| LastName | Agent’s last name |
| NickName | Agent’s nickname, if available |
| FullName | Agent’s first and last name |
| Company | Company where the agent works |
| Agent’s email address | |
| Phone | Agent’s mobile phone number |
| RetrProfileURL | Link to the agent’s RETR profile |
Transaction Activity Fields
All counts and volumes cover the 12 months before the ExportDate.
| Field | Description |
|---|---|
| BuyerCt_12Mo | Number of buyer-side transactions |
| BuyerVol_12Mo | Total buyer-side sales volume |
| SellerCt_12Mo | Number of seller-side transactions (listings) |
| SellerVol_12Mo | Total seller-side sales volume (listings) |
Loan Activity Fields
All counts and volumes cover the 12 months before the ExportDate and include only loans found for the agent’s purchase transactions.
| Field | Description |
|---|---|
| LoanCt_12Mo | Total number of loans |
| LoanOfficerCt_12Mo | Number of different loan officers across all of the agent’s loans |
| LoanCt_Conventional_12Mo | Number of conventional loans |
| LoanCt_VA_12Mo | Number of VA (U.S. Department of Veterans Affairs) loans |
| LoanCt_FHA_12Mo | Number of FHA (Federal Housing Administration) loans |
| LoanCt_LMI_12Mo | Number of loans in low- or moderate-income (LMI) census tracts |
| LoanVol_LMI_12Mo | Loan volume in low- or moderate-income (LMI) census tracts |
| LoanCt_MMCT_12Mo | Number of loans in majority-minority census tracts (MMCT) |
| LoanVol_MMCT_12Mo | Loan volume in majority-minority census tracts (MMCT) |
Export Details Fields
| Field | Description |
|---|---|
| Source | Data source (always “RETR”) |
| Tags | Custom labels for the contact, separated by commas |
| ListName | Name of the list the contact was exported from, if any |
| RETRAgentId | Unique RETR ID for the agent |
| ExportDate | Date the data was exported, which shows how current the data is |