Webhook is a popular integration technology used by companies like Github, Amazon, etc. The information is sent in real-time as it is recorded into our database.
To get started, provide YOUR Rently CLIENT SUCCESS MANAGER with a URL ENDPOINT where you want to receive the web post and RENTLY WILL FACILITATE TESTING AND DEPLOYMENT. The content of the post will be in JSON format. The best way to test the API is actually use Hurl.it or Postman tool so that you can post the following examples to your web end points and debug accordingly. PLEASE BE SURE TO DEBUG BEFORE PROVIDING THE URL TO YOUR RENTLY CSM.
Here is an example webhook post:
Content-Type: application/json
{
"type": "Self Registered Viewing",
"property_id": 16890,
"address": "2631 Miller Place, Thousand Oaks, CA",
"summary": "4BD | 3BA | $3,000 /mo",
"checkin_at": "05/13/2014 at 05:03AM",
"checkin_at_iso": "2014-05-03T05:03:00-07:00",
"prospect_name": "clark li",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "",
"source": "smartphone"
}
The webhook fields include:
-
type – event type possible values are
-
Prospect related webhooks:
- Direct Code Showing – When direct code is requested for showing
- Open House Scheduling – When open house showing is scheduled
- Open House Viewing – When open house access code is requested for viewing
- Self Scheduling – When a prospect schedule a future auto showing
- Self Registered Viewing – When an auto showing code was requested
- OTV Auto Showing – When an OTV link is sent for auto showing
- Customer Care Direct Code – When access code is requested from Customer Care
- Now Available – When a property becomes available for showing
- Safe Mode – When a prospect requested showing on a safe-mode-enabled property
- Prospect Comment – Prospect comments after viewing
- Pre Leased Lead Signup – When a prospect join in wait list for a preleased property
- inquiry – ILS inquiry
- Self Show Unlocked - When a self show code unlocked on Smart Hub lock
- iqual - A prospect iqual matches to a property
- Request Self Showing Scheduling - When a request self showing(Option from Scam Prevention Mode) was approved
- Requested Showing - When a request self showing was raised by prospect and waiting for approval
-
Trusted visitor related webhooks:
- Visitor Unlock – When access code fetched through manager portal
- Visitor Unshackle – When unshackle code is fetched through the manager portal
- Tenant Access – When Tenant Access move_in/move_out is triggered
- Call Center Lead – When a lead created from the call centre
-
-
property_id – this id corresponds to the property id in the account -> data export section
-
address – property address where the prospect visited
-
summary – the property information presented to the renter at the time of the showing
-
checkin_at – time of record, in format of local time of server timezone (PST - 08:00 / PDT - 07:00)
-
record_date - time of record, in format of local time of server timezone (PST - 08:00 / PDT - 07:00)
-
created_at - time of record, in format of local time of server timezone (PST - 08:00 / PDT - 07:00)
-
checkin_at_iso - time of record, in format of server timezone (PST - 08:00 / PDT - 07:00)
-
showing_timestamp - time of record, in format of server timezone (PST - 08:00 / PDT - 07:00)
-
prospect_name – full name of the renter
-
prospect_phone – phone of renter
-
source – technology renter used to view (smartphone or PC or phone)
-
property_tag – Property CRM Tag
Prospect comment-only fields:
- improvement_type – the area of improvement suggested by the renter
- notes – additional notes
- interest2: Are you interested in renting this property? (apply | question | no),
- access_problem: Was the lock box or key missing or broken? (true | false),
- property_problem: Were there any issues with the property we should be aware of? (vandalism | odor cleanliness | none)
- apply: (deprecated)
- interest:(deprecated)
- good_arrive:(deprecated)
- good_leave:(deprecated)
- rating: (deprecated)
Example of a prospect survey:
1. Was the lock box or key missing or broken?
- Yes
- No
2. Are you interested in renting this property?
- I’d like to apply
- I’m interested but have some questions
- I’d like to see other properties
3. If you’re not interested, what keeps you from renting the property today?
- Price Interior Condition Exterior Condition Landscaping
- Floor Plan Amenities Location/Neighborhood
- Size N/A – I liked everything about this property
4. Were there any issues with the property we should be aware of?
- Signs of vandalism or break-in
- Odor
- Cleanliness
- No issues
5. Additional Feedback:
Self Scheduling and Self Registered Viewing fields:
- utm_source - UTM parameter (if passed via Rently Self Tour Embed)
- utm_content - UTM parameter (if passed via Rently Self Tour Embed)
- utm_campaign - UTM parameter (if passed via Rently Self Tour Embed)
- utm_term - UTM parameter (if passed via Rently Self Tour Embed)
- utm_medium - UTM parameter (if passed via Rently Self Tour Embed)
Tenant Access Fields:
- tenant_name – the name of the tenant during tenant access registration
- tenant_phone – phone of tenant during tenant access registration
- access_type – move_in or move_out
There are other message types:
{
"property_id": 1377059,
"address": "4330 Largo Drive, Grand Prairie, TX, USA",
"summary": "3BD | 2.1BA | $1,600 /mo | 1800 sq ft",
"checkin_at": "04/01/2020 at 06:35AM",
"checkin_at_iso": "2020-04-01T06:35:01-07:00",
"prospect_name": "Andrea Munoz",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "",
"showing_timestamp": "2020-04-01T06:35:01-07:00",
"listing_id": "",
"secondary_external_id": "h000067",
"type": "Direct Code Showing",
"leasing_agent": "Krishna Upadhyaya"
}
{
"property_id": 1265919,
"address": "1114 Corkscrew Way, Villa Rica, GA 30180",
"summary": "5BD | 3.5BA | $1,850 /mo | Cats OK | Dogs OK | 3513 sq ft",
"checkin_at": "04/01/2020 at 07:12AM",
"checkin_at_iso": "2020-04-01T07:12:53-07:00",
"prospect_name": "Cabrina J",
"prospect_phone": "(123) 456-7890",
"email": "",
"property_tag": "GA16075",
"showing_timestamp": "2020-04-01T07:12:53-07:00",
"listing_id": "GA16075",
"secondary_external_id": "h000067",
"type": "Open House Scheduling",
"leasing_agent": ""
}
{
"property_id": 1268175,
"address": "7214 Ashley Falls Court, Douglasville, GA 30134",
"summary": "4BD | 2.5BA | $1,695 /mo | Cats OK | Dogs OK | 2406 sq ft",
"checkin_at": "04/01/2020 at 07:12AM",
"checkin_at_iso": "2020-04-01T07:12:54-07:00",
"prospect_name": "Zurianna Johnson",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "GA17972",
"showing_timestamp": "2020-04-01T07:12:54-07:00",
"listing_id": "GA17972",
"secondary_external_id": "h000067",
"type": "Open House Viewing",
"leasing_agent": ""
}
{
"property_id": 1479543,
"address": "3354 Allington Ct, Houston, TX",
"summary": "4BD | 2BA | $1,595 /mo | Cats OK | Dogs OK | 1708 sq ft",
"checkin_at": "04/01/2020 at 06:34AM",
"checkin_at_iso": "2020-04-01T06:34:39-07:00",
"prospect_name": "Chastity Johnson",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "132295",
"showing_timestamp": "2020-04-01T06:34:39-07:00",
"listing_id": "132295",
"secondary_external_id": "h000067",
"type": "Self Scheduling",
"visit_date": "04/05/2020"
}
Note: checkin_at and showing_stamp for above “Self Scheduling” both indicate when this schedule is created, instead of when showing is scheduled.
{
"property_id": 1184434,
"address": "608 REDSTONE AVENUE, EDMOND, OK 73013",
"summary": "3BD | 1.5BA | $1,120 /mo | 1126 sq ft",
"checkin_at": "04/01/2020 at 07:16AM",
"checkin_at_iso": "2020-04-01T07:16:26-07:00",
"prospect_name": "Marvin Stoll",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "c0f7e7d6-e825-4143-a2e3-84c22a77f25f",
"showing_timestamp": "2020-04-01T07:16:26-07:00",
"listing_id": "c0f7e7d6-e825-4143-a2e3-84c22a77f25f",
"secondary_external_id": "h000067",
"type": "Self Registered Viewing",
"source": "rently.com"
}
{
"property_id": 832886,
"address": "9630 Calle del Oro Ln, Dallas, TX, 75217",
"summary": "3BD | 2BA | $1,575 /mo | Cats OK | Dogs OK | 1308 sq ft",
"checkin_at": "04/01/2020 at 10:58AM",
"checkin_at_iso": "2020-04-01T10:58:46-07:00",
"prospect_name": "Lanita Andrews",
"prospect_phone": "(123) 456-7890",
"email": "",
"property_tag": "96308801",
"showing_timestamp": "2020-04-01T10:58:46-07:00",
"listing_id": "96308801",
"secondary_external_id": "h000067",
"type": "OTV Auto Showing",
"source": "call_center_guest_card"
}
{
"property_id": 855868,
"address": "123 Main Street, Los Angeles, CA, USA",
"summary": "1BD | 1BA | $667 /mo",
"checkin_at": "06/05/2019 at 08:09AM",
"checkin_at_iso": "2019-06-05T08:09:05-07:00",
"prospect_name": "Aaron Fowler",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "",
"showing_timestamp": "2019-06-05T08:09:05-07:00",
"listing_id": "",
"secondary_external_id": "h000067",
"type": "Customer Care Direct Code",
"leasing_agent": "",
"admin_name": "aaron"
}
{
"property_id": 1288699,
"address": "125 Rendition Drive, McDonough, GA 30253",
"summary": "3BD | 2BA | $1,550 /mo | Cats OK | Dogs OK | 1644 sq ft",
"checkin_at": "04/01/2020 at 07:35AM",
"checkin_at_iso": "2020-04-01T07:35:01-07:00",
"prospect_name": "Tara Penny",
"prospect_phone": "(123) 456-7890",
"email": "",
"property_tag": "GA14377",
"showing_timestamp": "2020-04-01T07:35:01-07:00",
"listing_id": "GA14377",
"secondary_external_id": "h000067",
"type": "Now Available"
}
{
"property_id": 657465,
"address": "7624 South Marshfield Avenue,Chicago,IL,60620",
"summary": "4BD | 2BA | $1,569 /mo | Cats OK | Dogs OK | 1600 sq ft",
"checkin_at": "04/01/2020 at 03:22PM",
"checkin_at_iso": "2020-04-01T15:22:00-07:00",
"prospect_name": "Tarita Smith",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "p0793911",
"showing_timestamp": "2020-04-01T15:22:00-07:00",
"listing_id": "p0793911",
"secondary_external_id": "h000067",
"type": "Safe Mode",
"visit_date":"12/10/2020"
}
{
"type": "Prospect Comment",
"property_id": 1223001,
"address": "713 Tree Green Lane, Wake Forest, NC 27587",
"summary": "4BD | 2.5BA | $2,150 /mo | Cats OK | Dogs OK | 2853 sq ft",
"created_at": "04/03/2020 at 11:38AM",
"prospect_name": "Jordan Blanchard",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"good_arrive": "",
"good_leave": "",
"interest": "",
"rating": "",
"improvement_type": "Price, Landscaping",
"interest2": "No",
"access_problem": false,
"property_problem": "none",
"property_tag": "1617225",
"notes": ""
}
{
"property_id": 1324536,
"address": "4102 Johnny Knoll, Winston Salem, NC, 27107",
"summary": "3BD | 2BA | $1,300 /mo | Cats OK | Dogs OK | 1040 sq ft",
"checkin_at": "06/03/2021 at 06:44AM",
"checkin_at_iso": "2021-06-03T06:44:13-07:00",
"listing_id": "45211",
"property_tag": "45211",
"prospect_name": "John Doe",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"showing_timestamp": "2021-06-03T06:44:13-07:00",
"secondary_external_id": "h000067",
"source": "rently_app",
"type": "Prelease Lead Signup"
}
{
"property_id": 1164350,
"address": "372 Griffin St NW, Atlanta, GA, 30314-3842",
"summary": "4BD | 2BA | $1,760 /mo | 1428.0 sq ft",
"checkin_at": "04/01/2020 at 05:16AM",
"checkin_at_iso": "2020-04-01T05:16:49-07:00",
"name": "Angel Jacobo",
"phone": "(123) 456-7890",
"voice_memo": "",
"property_tag": "1791197189",
"input": "",
"type": "Visitor Unlock"
}
{
"property_id": "",
"address": "",
"summary": "",
"checkin_at": "04/01/2020 at 06:51AM",
"checkin_at_iso": "2020-04-01T06:51:53-07:00",
"name": "Michael Ewing",
"phone": "(123) 456-7890",
"voice_memo": "",
"property_tag": "",
"input": "",
"type": "Visitor Unshackle"
}
{
"property_id": 1257964,
"address": "1631 Harrington Park Drive, Jacksonville, FL 32225",
"summary": "5BD | 4BA | $3,195 /mo | Cats OK | Dogs OK | 3472 sq ft",
"checkin_at": "04/01/2020 at 04:59PM",
"checkin_at_iso": "2020-04-01T16:59:28-07:00",
"phone": "+11234567890",
"property_tag": "FL16434",
"type": "Tenant Access",
"tenant_name": "S.Confiado",
"tenant_phone": "(123) 456-7890",
"access_type": "move_out"
}
{
"prospect_name": "Dana",
"prospect_phone": "(123) 456-7890",
"type": "Call Center Lead",
"listing_id": "p1078910",
"property_tag": "p1078910",
"market_id": 123,
"market": "Test Company",
"showing_timestamp": "2020-04-01T05:09:55-07:00",
"checkin_at_iso": "2020-04-01T05:09:55-07:00",
"email": "",
"move_in_date": "",
"notes": "cx called in asking about the home provide info",
"max_price": "",
"reason_for_move": "",
"prospect_status": "",
"home_choice_importance": ""
}
{
checkin_id: 123,
property_id: 456,
property_address: "1631 Harrington Park Drive, Jacksonville, FL 32225",
property_name: "FL16434",
record_date: "04/01/2020 at 04:59PM",
visitor_phone: "(123) 456-7890",
visitor_name: "Clark Li",
visitor_email: "[email protected]",
source: "Zillow",
type: "inquiry"
}
{
"property_id": 123456,
"address": "1043 ABC Way, San Antonio, TX, 78245",
"summary": "4BD | 2.5BA | $2,295 /mo | Cats OK | Dogs OK | 2439.0 sq ft",
"checkin_at": "08/06/2023 at 09:40PM",
"checkin_at_iso": "2023-08-06T21:40:21-07:00",
"prospect_name": "Clark Li",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "27055",
"showing_timestamp": "2023-08-06T21:40:21-07:00",
"listing_id": "27055",
"secondary_external_id": null,
"type": "Self Show Unlocked"
}
{
"name": "Clark Li",
"phone": "(123) 456-7890",
"email": "[email protected]",
"iqual_and_iqual_properties": [
{
"name": "12345",
"address": "123 Main Street",
"city": "Los Angeles",
"state": "CA",
"zipcode": "91008",
"no_of_bedrooms": 3,
"no_of_bathrooms": 2,
"price": 1595,
"property_iqual_badge": "Strong Match"
}
],
"iqual_score": 1,
"iqual_badge": "Strong Match",
"target_move_in_date": "2024-08-19",
"monthly_household_income": 5000,
"pets": false,
"no_of_cats": 0,
"no_of_dogs": 0,
"size_of_largest_breed": null,
"landlord_debt": false,
"eviction": false,
"eviction_years_ago": null,
"bankruptcy": false,
"felony": null,
"type": "iqual"
}
{
"property_id": 12345,
"address": "12345 Test Property",
"summary": "3BD | 2.5BA | $2,185 /mo | Cats OK | Dogs OK | 1534 sq ft",
"checkin_at": "04/09/2024 at 01:39AM",
"checkin_at_iso": "2024-04-09T01:39:27-07:00",
"prospect_name": "Test Prospect",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "12345",
"showing_timestamp": "2024-04-09T01:39:27-07:00",
"listing_id": "12345",
"secondary_external_id": null,
"type": "Request Self Showing Scheduling",
"leasing_agent": "ramanan"
}
{
"property_id": 12345,
"address": "12345 Test Property",
"summary": "1BD | 0.5BA | $1 /mo",
"checkin_at": "04/09/2024 at 03:32AM",
"checkin_at_iso": "2024-04-09T03:32:16-07:00",
"prospect_name": "Test Prospect",
"prospect_phone": "(123) 456-7890",
"email": "[email protected]",
"property_tag": "",
"showing_timestamp": "2024-04-09T03:32:16-07:00",
"listing_id": "",
"secondary_external_id": null,
"type": "Requested Showing",
"visit_date": null
}