Introduction
Embedding
Webhooks
Applications API
Applicants API
Properties API
Floor Plans API
Warning: Only resources, actions, and attributes documented here should be considered public. Any undocumented resources, actions, or attributes should be considred private and may change at any time without notice. Be extra cautious of undocumented attributes since those are the most likely to change.

If you with to use a undocumented portion of the API, please contact us first so we can either a) document it and make it public or b) explain what planned changes are in store for that part of the API.

Webhooks

QuickLease Pro offers a number of webhooks to help integrator’s know when key system events occur. We actually have a few more webhooks than documented here so let us know if you need something that you don’t see here.

All webhooks are sent via HTTPS to a URL you provide. They are sent as a POST with a JSON message as the body. If we have an issue delivering the webhook the system will automatically try to resend the webhook later. It will retry periodically for a minimum of 24 hours before giving up.

<span style=”font-family: monospace;”>application_form.started</span>

An application form is considered started when they filled out the first page of the questionnaire section of the online application form where we collect the applicant’s name and contact information. An application is not considered started unless they get to that point (even if they complete a few preliminary steps like reviewing pre-application disclosures)

{
  "event": "application_form.started",
  "test_mode": false,
  "data": {
    "applicant_id": 383424,
    "application_id": 193826,
    "property_id": 11309,
    "reference_id": null
  }
}

<span style=”font-family: monospace;”>application_form.completed</span>

This is sent when the applicant completed the online application form. It does not mean the background check has been ordered yet.

{
  "event": "application_form.completed",
  "test_mode": false,
  "data": {
    "applicant_id": 383424,
    "application_id": 193826,
    "property_id": 11309,
    "reference_id": null
  }
}

<span style=”font-family: monospace;”>background_check.ordered</span>

Sent as soon as the order is submitted to the screening platform. It does not mean that there is a background report available to view or that the CRA actually initiated the background check in their screening platform. Though under normal circumstances, both occur shortly after the background check is ordered.

This webhook is practically the same as the application_form.completed webhook above if you have QuickLease Pro set to order background checks automatically.

{
  "event": "background_check.ordered",
  "test_mode": false,
  "data": {
    "applicant_id": 383424,
    "application_id": 193826,
    "property_id": 11309,
    "reference_id": null
  }
}

<span style=”font-family: monospace;”>background_check.completed</span>

Delivered as soon as the background report is complete. Please note that you can receive this webhook more than once for the same applicant if the order status is the screening platform is changed after it has been completed.

{
  "event": "background_check.completed",
  "test_mode": false,
  "data": {
    "applicant_id": 383424,
    "application_id": 193826,
    "property_id": 11309,
    "reference_id": null
  }
}

<span style=”font-family: monospace;”>background_check.decision_updated</span>

Delivered if the decision is on the report is changed. This could arrive before or after the background_check.completed webhook.

{
  "event": "background_check.decision_updated",
  "test_mode": false,
  "data": {
    "applicant_id": 383424,
    "application_id": 193826,
    "property_id": 11309,
    "reference_id": null
  }
}

Other Webhooks

In addition, we have the following webhooks as well. Let us know if you need more information on any of these.