Skip to content

Platform Integrations

Via Webhooks

What is it?

Platform Integrations allow your mobile app to “talk” to other applications (like your CRM) and share important data in real-time. Since we use a technology called Webhooks, your mobile app can send data without a direct API connection. This means your mobile app can send data to thousands of external applications whenever something new happens without any additional development or special integrations.

How it benefits you?

When a user installs your app and enters their contact info, your mobile app can send the new contact to your CRM. This can kick off an automated welcome email, and a task can be scheduled to contact the user.

Later, the same user gets pre-qualified on your app, and it can trigger another workflow that sends a more personalized congrats email.

As a Mortgage Broker, you can use the pre-qualification data to send laser-targeted emails and complete parts of a mortgage application. Hence, no one has to rekey the info again.

As a Realtor, you can use the pre-qualification data to narrow the search filters and email your client new properties within their budget and location.

How to set it up

Admin > Webhooks > Get Started

Open your app and navigate to your Admin. Tap on Webhooks and Get Started

Get your Webhook URL

Ask your CRM company or the platform for your custom CMA Webhook URL. Copy and Paste it into your app.

That's it

Sit back and watch the data flow from your app to your favourite place.

Tutorials

BluMortgage

Get the Zoho Blu-CMA Extension

Brokeredge

Google Sheet

HubSpot

Mailchimp

Trello

For Developers

We currently support three types of payloads.

  1. Client Profile
  2. Client PreQualification
  3. CMA Leads

Client Profile

The profile data payload is posted when a client creates a new profile on the professional’s app or logs in to an existing account. The JSON data structure has a type key that shows this is a profile payload.

				
					{
    "type": "profile",
    "version": "1.0",
    "customerId": "CO36817",
    "ownerCustomerId": "23",
    "firstName": "Ben",
    "lastName": "Consumer 2",
    "email": "consumer2@bendigi.com",
    "phone": "416-720-3044",
    "localeIdentifier": "en",
    "defaultLocation":
    {
        "countryCode": "CA",
        "province": "ON",
        "city": "Toronto",
        "longitude": "-79.38459",
        "latitude": "43.80549"
    },
    "createdAt": "2020-07-07T21:40:21.172Z"
}

Aside from basic contact information, the payload also contains unique ids. 

customerId is the user’s unique id on your mobile app and should be stored in your CRM because future notifications about this user will include the same key/value so it can be cross-referenced. 

ownerCustomerId is the pro’s own unique id with us. This is particularly useful if the pro shares their CRM account with another colleague and both have an app with us. Here you may use the same webhook URL, and this field will help to identify from whose app the data originated.

Client PreQualification

The PreQualification data payload is our most comprehensive data set. The data is posted when a client completes or updates their scenario on their mobile app. The JSON data structure has a type key that identifies this payload as a prequalification. 

It also has a unique scenarioId; this system-generated id will live with the scenario. Even if the user updates their input and the data is recalculated and reposted, the scenarioId will not change. However, clients can have multiple PreQual scenarios, so if the user starts an entirely new scenario, the posted data will carry a new scenarioId. 

				
					{
    "type": "prequalification",
    "version": "1.0",
    "scenarioId": "3A3E9126-94F3-4D41-BAC0-B93D1BC16842",
    "scenarioTitle": "Sally",
    "contact": {...},
    "applicant":{...},
    "subjectProperty":{...},
    "mortgage":{...}, // ommited on Realtor apps
    "closingCosts":{...},
    "qualificationDetails":{...}
}

The Pre-Qualification payload is very comprehensive and comes in multiple sections.  If you want to parse all the fields fully, please read this. However, if you are just looking only to extract the most important information that the user has entered, look at the Contact, Applicant and Subject Property sections below.

Contact Section

This entire section is useful and should be retrieved in full.

				
					"contact": {
    "customerId": "69",
    "firstName": "Ben",
    "lastName": "Salami",
    "email": "consumer@bendigi.com",
    "phone": "416-720-3044"
}

Applicant Section

This will give you the information that the user has entered, including the total available funds they have saved up, their gross annual income, list of liabilities and if they own other properties. The income key is an array of incomes; however, currently, we only have one entry listed as employment income. In the future, users can enter other sources of income, hence the array.

				
					"applicant": {
    "totalAvailableFunds": 400000,
    "firstTimeBuyer": true,
    "foreignBuyer": false,
    "creditScoreRange": "800 - 900",
    "employmentType": "employed",
    "incomes": [
      {
        "amount": 150000,
        "type": "employmentincome",
        "frequency": "annual"
      }
    ],
    "liabilities": [],
    "nonSubjectProperties": []
},

Subject Property

The subject property section will contain the pre-qualified purchase price and other estimates. 

If you want the absolute minimum from this section, you should parse out

  1. purchasePrice,
  2. downPayment
  3. propertyLocation.

If you want to go a step further, also look at the propertyType and occupancy.

				
					"subjectProperty": {
    "purchasePrice": 999999,
    "totalMonthlyCost": 5417.634998018308,
    "propertyType": "house",
    "brandNewHome": false,
    "propertyLocation": {
      "province": "Ontario",
      "city": "Toronto",
      "municipality": "toronto",
      "fullAddress": "Toronto, ON, Canada",
      "placeId": "ChIJpTvG15DL1IkRd8S0KlBVNTI"
    },
    "occupancy": "ownerOccupied",
    "rentalIncome": {},
    "downPayments": [
      {
        "amount": 173673.9875,
        "type": "personalcash"
      }
    ],
    "expenses": [
      {
        "type": "propertytax",
        "payment": 5997.03400296,
        "frequency": "annual"
      },
      {
        "type": "heat",
        "payment": 150,
        "frequency": "monthly"
      }
    ]
}

CMA Leads

CMA Leads are generated from  users who submit a mortgage requests on the generic Canadian Mortgage App. In order for a professional to receive such leads, they will need to be part of the referral program here.

All payloads are posted with type = lead. 

Further, the leadType defines the exact place on the app where these users have submitted the request from. This is not very important once the leads are received but here is what they mean:

  1. lead_preq: This type of lead is directly generated in the pre-qualification tool 
  2. lead_contact: The user used the main contact form in the home screen or inside one of the tools that allows submission.
  3. lead_quote: The user visited the rate screen and decided to request a quote for a rate
  4. lead_rate: The user went further into a specific rate on the app and decided to apply for it.
 

Mortgage Goal

One of the more important properties in the lead payload is the key mortgageGoal. There are 5 options. Depending on the option, scenario data may also be attached. The 5 options are preapproval, purchase, refinance, renew or other.

Here are some examples of payload for each mortgage goal.

Go PRO
TAP HERE TO GO PRO

Scan to GO PRO

or learn how to do it manually

What PROs are saying

Tons of positive feedback
Cody Rowe
Read More
I’m getting tons of positive feedback – not to mention new clients – by getting this app in the hands of my referral partners.
Very helpful!
TanyaBangay
Read More
As a Realtor, I frequently use this app as a quick reference to give my clients an idea of what expenses will be.
Best mortgage app!!
dremanage416
Read More
I use this app at least one a day. Text it to my clients to pre-fill the applications makes my life easier.
Great App
Bosley Jos ,
Read More
I'm a réaltor in downtown Toronto and I make my clients download this app. It allows us to compare costs of various properties easily and accurately. Keep up the good work!
Favourite App for business
cvwmwaw
Read More
As a real estate Broker this App is amazing for my clients. It helps them play around with different purchase price scenarios, calculate closing costs & down payments etc....it also helps me run quick numbers for investor clients on the spot. The Pro is worth it all day long! The support staff is great and very responsive.
I love this app!!
jhiggelke
Read More
I have been a mortgage broker for 12 years and this is the best mortgage calculator app that I have ever used. I am very excited to share it with both my clients and referral sources! Thank you!!
Awesome app.
Hoben2011
Read More
I cannot live without this app. Immensely useful for qualifying buyers on the spot and show my expertise
Best Apps for rental property in Canada
lildavesflava
Read More
How was it even possible to be an investor before this one came out. Best app ever made. Take in consideration all the subtlety of the Canadian market
Great real-estate investing app
Doubt fire
Read More
As a new real estate investor, this app is my number one go-to resource for quickly comparing and evaluating the properties I'm looking at. Great interface, and easy to use.
This App Rocks
KrispyLovesRealEstate
Read More
I'm a Real Estate Sales Professional in Ontario- this app covers it all! Land transfer tax calculations, mortgage insurance calculations, etc. They thought of everything when they developed this app!
Indispensable
Livingonthegoon
Read More
I'm able to quote clients accurate numbers on mortgages including CMHC fees in seconds.
Best Mortgage App
HincheyHomes
Read More
I love this app. Makes me look professional in front of my clients. Quick and easy enough anyone can use it.
Previous
Next

Quick, easy and accurate
Simply Powerful

Download the Free app

apple_en
apple_en
google_play_en
google_play_en

How to get the app

Since you are not glued to your phone (for once), you have 3 options for downloading the app

Text yourself a link

.. and have no fear, we don't save your number.

Scan this QR code and go to the app store

OR check us out on the App Store or Google Play