Skip to main content

Lease Offer Selected

Overview

·Event key:
lease_transaction.lease_offer_selected

This event notifies your callback URL when a renewal lease offer is selected and a new lease is generated. Use it to sync renewal selections, selected lease terms, and newly created lease records to downstream systems.

When This Event Triggers

This event fires when a renewal is countersigned and the selected lease offer becomes the effective lease offer for the newly generated renewal lease.

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
  }
}