Event Object

Welcome to the documentation for Funnel Leasing's Event Object. Here, you'll learn how to seamlessly integrate event-driven functionality into your applications by listening to events generated within your Funnel Leasing account.

Funnel Leasing generates event data to keep you informed about activities related to your applications, residents, and units. These events are pivotal in maintaining the synchronicity between your systems and Funnel Leasing.

How It Works

When an event occurs, such as the status change of an application from Submitted to being Approved by a Leasing Professional, Funnel Leasing creates a new Event object. This object encapsulates the pertinent details of the event, allowing you to react accordingly. For instance, upon receiving a lease_transaction.status_updated event, your system can automate actions like reserving a unit in your Property Management System (PMS).

Listening to Events

By registering webhook endpoints in your Funnel Leasing account, you empower Funnel Leasing to automatically dispatch Event objects to these endpoints via POST requests whenever an event occurs. This enables your application to respond promptly and effectively.

The Event Object

The Event object dispatched to your webhook endpoint provides a comprehensive snapshot of the changes that have taken place. Let's delve into its structure and contents.

Example Event Payload

Here's an example of the payload you can expect to receive:

Example Event Payload

{
  "id": "8cc87045-0e02-4a16-a882-454044e6762a",
  "event": "lease_transaction.status_updated",
  "timestamp": "2024-10-09T13:49:31.658518+00:00",
  "data": {
    "lease_id": null,
    "client_id": 16167303,
    "community_id": 831,
    "current_status": "Conditionally Approved",
    "previous_status": "Submitted",
    "unit_pms_identifier": "u1234",
    "lease_transaction_id": 413513,
    "tenant_pms_identifier": "t1234",
    "lease_transaction_type": "Application",
    "community_pms_identifier": "c1234"
  }
}

Event Object Structure

Let's break down the components of the Event object:

id: A UUID string identifying the event itself, not an individual delivery attempt. The same id is sent again on every retry of a failed delivery, and to each of your endpoints subscribed to that event, so you can use it as an idempotency key to avoid processing the same event twice. It is also what to reference when contacting Funnel about a delivery issue.
event: The event type (for example, lease_transaction.status_updated), matching one of the names on the Events List. This determines the shape of the accompanying data object.
timestamp: An ISO-8601 datetime string (with timezone offset) denoting when the event occurred — not a Unix/epoch timestamp.
data: Contains the event's payload fields. Its structure varies by event type — see each event's own page under the Events List for its exact field list.

ℹ️

Scoping IDs live inside data, not the envelope

Every real example payload on this site — across every documented event — contains only id, event, timestamp, and data. There is no separate top-level company/community/group/user scoping field. If you need to know which company or community an event belongs to, look for the relevant id field (e.g. community_id) inside data itself.

Next Steps

To explore the full spectrum of event types that Funnel Leasing sends to your webhook, refer to the complete list of event types. Understanding these events and their payloads will empower you to build robust integrations that leverage real-time data from Funnel Leasing.

ℹ️

Ready to integrate?

With this documentation, you're equipped to harness the power of event-driven architecture within your Funnel Leasing integration. Should you have any queries or require further assistance, feel free to reach out to our support team. Happy integrating!