Skip to main content

Resident Move-in

Overview

·Event key:
lease.resident_move_in

This event enables real-time tracking of resident move-ins and lease activation. Use it to update occupancy records, synchronize property management systems, trigger welcome workflows, update resident status across platforms, and maintain accurate occupancy data for reporting and operations.

When This Event Triggers

This event fires when a resident officially moves into their unit and the lease becomes active. This event only fires for communities that have the "Manual Move-In Workflow" feature enabled, which allows leasing agents to explicitly confirm when a resident has taken possession of their unit. The event fires in the following scenario:

  • Move-In ConfirmedWhen a leasing agent marks a resident as "Moved In" in the system, confirming that the resident has taken possession of their unit. This action changes the lease status from "Upcoming" to "Active" and records the official move-in. This is a deliberate action taken by property staff to confirm that the resident has physically moved into the unit. It is not triggered automatically based on the lease start date, but rather requires manual confirmation from the leasing team.

When this event fires:

  • The lease status changes from "Upcoming" to "Active"
  • Any pending "Move-In Needs Attention" action items are cleared
  • The resident's group assignment status may be updated

The event payload includes details about the lease such as:

  • The lease ID
  • The move-in date
  • PMS identifiers for the tenant, unit, and community

This event is useful for integrating with external systems that need to know when a resident has officially taken occupancy, such as utility activation services, access control systems, or Property Management Systems that track occupancy status.

Event Payload

Example payloadJSON200 · application/json
{
"id": "8cc87045-6666-4a16-a882-454044e6762a",
"event": "lease.resident_move_in",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
"lease_id": 74827,
"tenant_pms_identifier": "t1234",
"unit_id": 4355,
"unit_pms_identifier": "u1234",
"community_id": 435245,
"community_pms_identifier": "c1234",
"move_in_date": "2023-05-01"
}
}