Skip to main content

Lease Offer Selected

Overview

·Event key:
lease_transaction.lease_offer_selected

This event notifies your callback URL that a renewal has been completed with a selected lease offer. It identifies the effective lease offer, its term, and the new renewal lease created from it.

When This Event Triggers

This event fires once, when the renewal is countersigned and Funnel creates the new active or upcoming renewal lease with the selected offer as its effective lease offer. It does not fire when the resident initially selects the offer, and lease creation does not produce a separate second event; new_lease_id identifies the generated lease in this event.

Event Payload

Example payloadJSON200 · application/json
{
  "id": "8cc87045-ffff-4a16-a882-454044e6762a",
  "event": "lease_transaction.lease_offer_selected",
  "timestamp": "2024-10-09T13:49:31.658518+00:00",
  "data": {
    "lease_transaction_id": 54321,
    "lease_offer_external_id": "LO-1234",
    "lease_offer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "term_months": 12,
    "client_id": 67890,
    "guestcard_pms_identifier": "g1234",
    "tenant_pms_identifier": "t1234",
    "community_id": 435242,
    "community_pms_identifier": "c1234",
    "new_lease_id": 12345
  }
}