Rental Application Notification Through Webhook

Webhook is a popular integration technology used by companies like Github, Amazon, etc. The information is sent in real-time as it is recorded in 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 used http://hurl.it/ or Postman tool so that you can post the following examples to your web endpoints 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: Application Updated

"application_id": 309302, "property": { "property_id": 4133967, "property_type": "single family", "address": "GJJX2V44PUTUPCQU5NO6GRO1KINJWK", "company": "00 Rently Demo Account", "bedroom": 3.0, "bathrooms": 2.0, "deposit": null, "rent": 1500.0 }, "applicants": [ { "id": 282986, "rently_prospect_id": 56877, "name": "Manomoy Biswas", "phone": "(999) 991-1112", "email": "test12@example.com", "dob": "1995-02-14", "completion_percentage": "100%", "completion_date": "2023-05-03T13:04:16-07:00", "application_expiry": "2023-06-02T00:00:00-07:00", "relationship": "", "residences": [ { "current_residence": true, "street_address": "1 World Way", "city": "Los Angeles", "state": "CA", "zipcode": "90045", "residence_type": "rented", "monthly_payment": null, "monthly_rent": 250, "reason_for_moving": "Relocation due to Job change", "move_in_date": "2022-01-01", "move_out_date": null, "landlord_name": "Sufi Yong", "landlord_phone": "(446) 546-5456", "landlord_email": "sufi@example.com", "landlord_fax": "" }, { "current_residence": false, "street_address": "2 World Way", "city": "Los Angels", "state": "CA", "zipcode": "90045", "residence_type": "owned", "monthly_payment": "1200", "monthly_rent": null, "reason_for_moving": "", "move_in_date": "2013-01-01", "move_out_date": "2020-12-01", "landlord_name": null, "landlord_phone": null, "landlord_email": null, "landlord_fax": null } ], "references": [ { "reference_type": "Personal", "name": "Rahul Das", "relationship": "Other", "address": "Kolkata, India", "phone": "(165) 651-8948" }, { "reference_type": "Emergency", "name": "Arpita Saha", "relationship": "Sibling", "address": "Kolkata, India", "phone": "(123) 456-7890" } ], "occupations": [ { "current_employment": true, "status": "employed", "employer": "Rently.com", "job_title": "Software Engineer", "employed_from": "2020-10-01", "employed_upto": null, "monthly_income": 3000, "manager_name": "Kalyan T", "manager_phone": "(123) 456-7890", "work_address": "Kolkata, India" }, { "current_employment": true, "status": "employed", "employer": "Rental Application", "job_title": "Software Developer", "employed_from": "2020-12-10", "employed_upto": null, "monthly_income": 3000, "manager_name": "Luv", "manager_phone": "(123) 456-7890", "work_address": "Kolkata, India" }, { "current_employment": true, "status": "self_employed", "income_source": "testing", "monthly_income": 778 }, { "current_employment": true, "status": "student", "income_source": "Teaching", "monthly_income": 968 }, { "current_employment": false, "status": "employed", "employer": "rently", "job_title": "Developer", "employed_from": "2024-01-01", "employed_upto": "2024-12-01", "monthly_income": 747, "manager_name": "kalyan", "manager_phone": "(757) 367-5735", "work_address": "" }, { "current_employment": false, "status": "other", "income_source": "fruits", "monthly_income": 765 }, { "current_employment": false, "status": "student", "income_source": "abc", "monthly_income": 7878 }, { "current_employment": false, "status": "self_employed", "income_source": "Business", "monthly_income": 4754 }, { "additional_income": true, "income_source": "Freelancer", "monthly_income": 4889 } ], "type": "Primary Applicant", "created_at": "2023-02-13T20:02:08-08:00", "updated_at": "2023-05-03T13:04:16-07:00" }, { "id": 283592, "rently_prospect_id": 65887, "name": "Ramanan T", "phone": "(123) 456-7890", "email": "ramanan@example.com", "dob": "1994-06-14", "completion_percentage": "100%", "completion_date": "2023-05-03T13:14:38-07:00", "application_expiry": "2023-06-02T00:00:00-07:00", "relationship": "Roommate", "residences": [ { "current_residence": true, "street_address": "1 World Way", "city": "Los Angeles", "state": "CA", "zipcode": "90045", "residence_type": "owned", "monthly_payment": "1250", "monthly_rent": null, "reason_for_moving": "", "move_in_date": "2012-01-01", "move_out_date": null, "landlord_name": null, "landlord_phone": null, "landlord_email": null, "landlord_fax": null } ], "references": [ { "reference_type": "Personal", "name": "Rahul Das", "relationship": "Other", "address": "Kolkata, India", "phone": "(123) 455-6789" }, { "reference_type": "Emergency", "name": "Arpita Saha", "relationship": "Sibling", "address": "Kolkata, India", "phone": "(765) 765-7657" } ], "occupations": [ { "current_employment": true, "status": "employed", "employer": "Rently.com", "job_title": "Software Engineer", "employed_from": "2020-10-01", "employed_upto": null, "monthly_income": 3000, "manager_name": "Kalyan T", "manager_phone": "(123) 456-7890", "work_address": "Kolkata, India" }, { "current_employment": true, "status": "self_employed", "income_source": "testing", "monthly_income": 778 }, { "current_employment": true, "status": "student", "income_source": "Teaching", "monthly_income": 968 }, { "current_employment": false, "status": "employed", "employer": "rently", "job_title": "Developer", "employed_from": "2024-01-01", "employed_upto": "2024-12-01", "monthly_income": 747, "manager_name": "kalyan", "manager_phone": "(757) 367-5735", "work_address": "" }, { "current_employment": false, "status": "other", "income_source": "fruits", "monthly_income": 765 }, { "current_employment": false, "status": "student", "income_source": "abc", "monthly_income": 7878 }, { "current_employment": false, "status": "self_employed", "income_source": "Business", "monthly_income": 4754 }, { "additional_income": true, "income_source": "Freelancer", "monthly_income": 4889 } ], "type": "Co-applicant", "created_at": "2023-05-03T12:58:57-07:00", "updated_at": "2023-05-03T13:14:39-07:00" } ], "occupants": [ { "id": 486032, "name": "Depashree T", "relationship": "Son/Daughter", "created_at": "2023-05-03T12:58:57-07:00", "updated_at": "2023-05-03T12:58:57-07:00" } ], "guarantors": [ { "id": 283593, "rently_prospect_id": 56345, "name": "Rajarshi Ghosh", "phone": "(342) 432-4234", "email": "rajarshi@example.com", "dob": "1990-07-09", "completion_percentage": "100%", "completion_date": "2023-05-03T13:23:04-07:00", "application_expiry": "2023-06-02T00:00:00-07:00", "relationship": "Guarantor/Cosigner", "residences": [ { "current_residence": true, "street_address": "4455 Paradise Road", "city": "Las Vegas", "state": "NV", "zipcode": "89169", "residence_type": "rented", "monthly_payment": null, "monthly_rent": 3000, "reason_for_moving": "", "move_in_date": "2020-01-01", "move_out_date": null, "landlord_name": "John Doe", "landlord_phone": "(876) 545-4547", "landlord_email": "jogn@example.com", "landlord_fax": "" } ], "references": [ { "reference_type": "Personal", "name": "Rahul Das", "relationship": "Other", "address": "Kolkata, India", "phone": "(654) 321-7890" }, { "reference_type": "Emergency", "name": "Navnath S", "relationship": "Sibling", "address": "Pune, India", "phone": "(789) 065-4321" } ], "occupations": [ { "current_employment": true, "status": "employed", "employer": "Rently.com", "job_title": "Software Engineer", "employed_from": "2020-10-01", "employed_upto": null, "monthly_income": 3000, "manager_name": "Kalyan T", "manager_phone": "(123) 456-7890", "work_address": "Kolkata, India" }, { "current_employment": true, "status": "self_employed", "income_source": "testing", "monthly_income": 778 }, { "current_employment": true, "status": "student", "income_source": "Teaching", "monthly_income": 968 }, { "current_employment": false, "status": "employed", "employer": "rently", "job_title": "Developer", "employed_from": "2024-01-01", "employed_upto": "2024-12-01", "monthly_income": 747, "manager_name": "kalyan", "manager_phone": "(757) 367-5735", "work_address": "" }, { "current_employment": false, "status": "other", "income_source": "fruits", "monthly_income": 765 }, { "current_employment": false, "status": "student", "income_source": "abc", "monthly_income": 7878 }, { "current_employment": false, "status": "self_employed", "income_source": "Business", "monthly_income": 4754 }, { "additional_income": true, "income_source": "Freelancer", "monthly_income": 4889 } ], "type": "Guarantor", "created_at": "2023-05-03T13:03:46-07:00", "updated_at": "2023-05-03T13:23:04-07:00" } ], "household_details": { "move_in_date": "2023-02-28", "total_households": 3, "total_applicants": 2, "total_occupants": 1, "total_guarantors": 1, "completion_percentage": "100%", "pets": { "total_pets": 5, "dog_count": 2, "cat_count": 3 } }, "type": "Application Updated" }

The webhook fields include:

type – event type possible values are Application Started – When a new application created Application Submitted - When the Primary applicant completes their payment and submits the application Application Updated - When an applicant updates the application after submission. application_id - This is a unique key to identify each application property - it holds the property details that the applied by the primary applicant property_id - This id corresponds to the property that the applicant applied for. property_type - This will tell the property type either a single-family or multi-family address - property address where the prospect applied company - company name to which property belongs, bedroom - No. of Bedroom present in the property bathrooms - No. of Bathroom Present on the property deposit - A deposit is required for this property rent - Monthly rent required for the property applicants - An array of applicants. Each applicant will hold the below properties id - This id corresponds to the applicant (unique identifier). name - Name of the applicant phone - phone number of the applicant email - Email ID of the applicant dob - Date of Birth of the applicant completion_percentage - The percentage of an application completed by the applicant completion_date - Timestamp of when the application submitted application_expiry - Timestamp of when the application will expire relationship - Relationship to the primary applicant. Will be blank for the Primary applicant residences - An array of residences. There can be two types of residence as below current_residence - This will be true if the provided details are the applicant's current residence street_address - Street address where the applicant resided city - The city where the applicant resided state - State where the applicant resided zipcode - Zipcode where the applicant resided residence_type - Type of residence either owned or rented monthly_payment - Monthly expense required for owned property monthly_rent - Monthly rent paid for the rented property reason_for_moving - Any specific reason to change the property that the applicant provided move_in_date - Date when the applicant moved into this address move_out_date - Date when the applicant moved out from that address. This will be blank if it is the current residence landlord_name - Landlord named of the residence property landlord_phone - This is the landlord’s contact number landlord_email - This is the landlord's email id if available landlord_fax - This is Landlord’s fax if available references - This will be an array of reference contact persons. Each reference will hold below details reference_type - This tells us the types of reference personal emergency. name - Name of the reference contact person relationship - Relationship to the applicant address - Communication address of the applicant phone - Contact number of the applicant occupations - An applicant can hold multiple occupation details. It will be either current occupation or previous occupation. An applicant can also have additional income current_employment - This will be true if the occupation information is the current source of income status - This will tell us the type of occupation. Possible values will be Self-employed Employed Student Unemployed Other There can be three types of structure of this occupation information based on status and employment type. When current employment or previous employment When the status is self-employed, student, or Unemployed income_source - Source of income monthly_income - Amount the applicant earns in a month When the status is salaried employer - employer name job_title - current designation employed_from - Job start date employed_upto - Job end date. Empty for current employment monthly_income - Monthly salary that the applicant earns manager_name - Managers name manager_phone - Managers contact number When Additional income additional_income - This will be true if additional income income_source - Source of income monthly_income - Amount the applicant earns in a month type - there will be two types Primary Applicant - when the details belong to the primary applicant Co Applicant - when the details belong to a co-applicant created_at - when the applicant created updated_at - when the applicant last modified occupants - This will be an array of hash that holds the details of household members who are below 18 years of age. Each will hold the below information id - This id corresponds to the occupant (unique identifier) name - Name of the Occupant relation - Relation to the Primary Applicant created_at - when the occupant created updated_at - when the applicant last modified guarantor - This will be an array of hash. It holds the guarantor’s details. Each will hold the below details type - type will be always the “Guarantor” All data will be the same as the Applicants household_details - This will hold the household information move_in_date - The date when the applicant willing to move into the property total_households - Total number of household (primary applicant + co-applicant + occupant) total_applicants - Total number of applicants (primary applicant + co-applicant) total_occupants - Total number of occupants total_guarantor - Total number of Guarantor completion_percentage - Average household completion percentage Formula: ((completion % of applicant1 + completion % of applicant2 +…+ completion % of applicant n)/no. of applicant pets - pets information total_pets - Total Number of pets going to stay on the property dog_count - Number of dogs going to stay on the property cat_count - Number of cats going to stay on the property

Below is the webhook response for the different states of the application. The type will be updated accordingly.

Type: Application Started

{ "application_id": 309912, "property": { "property_id": 4133967, "property_type": "single family", "address": "GJJX2V44PUTUPCQU5NO6GRO1KINJWK", "company": "00 Rently Demo Account", "bedroom": 3.0, "bathrooms": 2.0, "deposit": null, "rent": 1500.0 }, "applicants": [ { "id": 283594, "rently_prospect_id": 56877, "name": "Manomoy Biswas", "phone": "(333) 333-7677", "email": "testwebhook@manomoy.com", "dob": null, "completion_percentage": "0%", "completion_date": null, "application_expiry": null, "relationship": "", "residences": [ { "current_residence": true, "street_address": null, "city": null, "state": null, "zipcode": null, "residence_type": "rented", "monthly_payment": null, "monthly_rent": null, "reason_for_moving": null, "move_in_date": null, "move_out_date": null, "landlord_name": null, "landlord_phone": null, "landlord_email": null, "landlord_fax": null } ], "references": [ ], "occupations": [ ], "type": "Primary Applicant", "created_at": "2023-05-03T13:26:31-07:00", "updated_at": "2023-05-03T13:26:31-07:00" } ], "occupants": [ ], "guarantors": [ ], "household_details": { "move_in_date": null, "total_households": 1, "total_applicants": 1, "total_occupants": 0, "total_guarantors": 0, "completion_percentage": "0%", "pets": { "total_pets": 0, "dog_count": 0, "cat_count": 0 } }, "type": "Application Started" }

Type: Application Submitted

{ "application_id": 309302, "property": { "property_id": 4133967, "property_type": "single family", "address": "GJJX2V44PUTUPCQU5NO6GRO1KINJWK", "company": "00 Rently Demo Account", "bedroom": 3.0, "bathrooms": 2.0, "deposit": null, "rent": 1500.0 }, "applicants": [ { "id": 282986, "rently_prospect_id": 56877, "name": "Manomoy Biswas", "phone": "(999) 991-1112", "email": "test12@example.com", "dob": "1995-02-14", "completion_percentage": "100%", "completion_date": "2023-05-03T13:04:16-07:00", "application_expiry": "2023-06-02T00:00:00-07:00", "relationship": "", "residences": [ { "current_residence": true, "street_address": "1 World Way", "city": "Los Angeles", "state": "CA", "zipcode": "90045", "residence_type": "rented", "monthly_payment": null, "monthly_rent": 250, "reason_for_moving": "Relocation due to Job change", "move_in_date": "2022-01-01", "move_out_date": null, "landlord_name": "Sufi Yong", "landlord_phone": "(446) 546-5456", "landlord_email": "sufi@example.com", "landlord_fax": "" }, { "current_residence": false, "street_address": "2 World Way", "city": "Los Angels", "state": "CA", "zipcode": "90045", "residence_type": "owned", "monthly_payment": "1200", "monthly_rent": null, "reason_for_moving": "", "move_in_date": "2013-01-01", "move_out_date": "2020-12-01", "landlord_name": null, "landlord_phone": null, "landlord_email": null, "landlord_fax": null } ], "references": [ { "reference_type": "Personal", "name": "Rahul Das", "relationship": "Other", "address": "Kolkata, India", "phone": "(165) 651-8948" }, { "reference_type": "Emergency", "name": "Arpita Saha", "relationship": "Sibling", "address": "Kolkata, India", "phone": "(123) 456-7890" } ], "occupations": [ { "current_employment": true, "status": "employed", "employer": "Rently.com", "job_title": "Software Engineer", "employed_from": "2020-10-01", "employed_upto": null, "monthly_income": 3000, "manager_name": "Kalyan T", "manager_phone": "(123) 456-7890", "work_address": "Kolkata, India" }, { "current_employment": true, "status": "employed", "employer": "Rental Application", "job_title": "Software Developer", "employed_from": "2020-12-10", "employed_upto": null, "monthly_income": 3000, "manager_name": "Luv", "manager_phone": "(123) 456-7890", "work_address": "Kolkata, India" }, { "current_employment": true, "status": "self_employed", "income_source": "testing", "monthly_income": 778 }, { "current_employment": true, "status": "student", "income_source": "Teaching", "monthly_income": 968 }, { "current_employment": false, "status": "employed", "employer": "rently", "job_title": "Developer", "employed_from": "2024-01-01", "employed_upto": "2024-12-01", "monthly_income": 747, "manager_name": "kalyan", "manager_phone": "(757) 367-5735", "work_address": "" }, { "current_employment": false, "status": "other", "income_source": "fruits", "monthly_income": 765 }, { "current_employment": false, "status": "student", "income_source": "abc", "monthly_income": 7878 }, { "current_employment": false, "status": "self_employed", "income_source": "Business", "monthly_income": 4754 }, { "additional_income": true, "income_source": "Freelancer", "monthly_income": 4889 } ], "type": "Primary Applicant", "created_at": "2023-02-13T20:02:08-08:00", "updated_at": "2023-05-03T13:04:16-07:00" }, { "id": 283592, "rently_prospect_id": 65887, "name": "Ramanan T", "phone": "(123) 456-7890", "email": "ramanan@example.com", "dob": null, "completion_percentage": "0%", "completion_date": null, "application_expiry": null, "relationship": "Roommate", "residences": [ ], "references": [ ], "occupations": [ ], "type": "Co-applicant", "created_at": "2023-05-03T12:58:57-07:00", "updated_at": "2023-05-03T12:58:57-07:00" } ], "occupants": [ { "id": 486032, "name": "Depashree T", "relationship": "Son/Daughter", "created_at": "2023-05-03T12:58:57-07:00", "updated_at": "2023-05-03T12:58:57-07:00" } ], "guarantors": [ { "id": 283593, "rently_prospect_id": 346575, "name": "Rajarshi Ghosh", "phone": "(342) 432-4234", "email": "rajarshi@example.com", "dob": null, "completion_percentage": "0%", "completion_date": null, "application_expiry": null, "relationship": "Guarantor/Cosigner", "residences": [ ], "references": [ ], "occupations": [ ], "type": "Guarantor", "created_at": "2023-05-03T13:03:46-07:00", "updated_at": "2023-05-03T13:03:46-07:00" } ], "household_details": { "move_in_date": "2023-02-28", "total_households": 3, "total_applicants": 2, "total_occupants": 1, "total_guarantors": 1, "completion_percentage": "33%", "pets": { "total_pets": 2, "dog_count": 1, "cat_count": 1 } }, "type": "Application Submitted" }