Lease Transaction Updated

Overview

·Event key:

lease_transaction.updated

This event provides comprehensive tracking of all changes to lease transactions, including milestone progress, workflow step changes, participant additions, and term updates. Use it as a catch-all webhook to keep your systems synchronized with any transaction modifications, trigger general update workflows, maintain audit logs, and ensure your platform reflects the latest transaction state.

When This Event Triggers

This event is triggered whenever a significant update occurs on a lease transaction that doesn't fall into the more specific event categories (like status changes or terms updates). It serves as a general-purpose notification for various actions taken by applicants, residents, or leasing agents. The event fires for any of the following scenarios:

• Household Changes (by Applicants) — A dependent (such as a child) is added to the application; a co-applicant is invited to join the application; a guarantor is invited to co-sign the lease; an occupant is invited to be added to the lease.
• Household Changes (by Agents) — A leasing agent adds a co-applicant, occupant, or guarantor on behalf of the applicant; a dependent, guarantor, occupant, or co-applicant is removed from the application.
• Document and Signature Events — An applicant signs the lease document; a leasing agent countersigns the lease document; a mid-lease change document is countersigned; a notice to vacate document is countersigned or completed; the lease document is sent to applicants for signature; an offline lease document is uploaded.
• Other Significant Updates — A guarantor is requested for the application; the application is rescreened (background/credit check re-run); an applicant's role is changed (e.g., from co-applicant to primary applicant); the primary applicant is changed; concessions (discounts) are added, removed, or modified; rental options (parking, pets, storage, etc.) are changed; rental option pricing is updated; the move-out date is overridden by an agent; an agent updates an applicant's personal details; an applicant's address is changed.

The event payload includes an update_type field that specifies exactly which type of update occurred, allowing receiving systems to handle each scenario appropriately.

Event Payload

Example payloadJSON200 · application/json

{
"id": "8cc87045-3333-4a16-a882-454044e6762a",
"event": "lease_transaction.updated",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "lease_transaction_id": 74825,
  "lease_transaction_type": "Application",
  "client_id": 12457534,
  "tenant_pms_identifier": "t1234",
  "unit_pms_identifier": "u1234",
  "community_id": 435242,
  "community_pms_identifier": "c1234",
  "lease_id": null,
  "update_type": "Agent updated applicant personal details",
  "context": {
    "email": "josh.doe@funnelleasing.com",
    "suffix": "jr",
    "has_ssn": true,
    "last_name": "Doe",
    "first_name": "John",
    "middle_name": null,
    "address_city": "Atlanta",
    "phone_number": "(701) 885-9206",
    "address_state": "GA",
    "date_of_birth": "1988-08-23",
    "address_street": "5530 cherry street",
    "address_line_2": "1",
    "address_postal_code": "30040"
  }
}
}