Skip to main content

Renter Created

Overview

·Event key:
renter.created
⚠️
Legacy Webhook - DeprecatedThis webhook is part of the legacy webhook system. For new integrations, we recommend using the modern webhooks v2 system.

Webhook triggered when a renter is created in Funnel Leasing. This event provides all the initial information about the renter, including contact details, preferences, and any initial messages or listing interests.

When this event fires

This event is triggered when:

  • New renter creation: When a new renter/prospect is created in the Funnel Leasing system
  • Initial registration: When someone first registers or becomes a prospect through any channel

Event Payload

Example payloadJSON200 · application/json
{
  "event": "renter.created",
  "data": {
    "funnel_renter_id": 456678,
    "funnel_community_id": 1234,
    "status": "Prospect",
    "people": [
      {
        "id": 111,
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "phone_1": "510-555-4567",
        "phone_2": "",
        "sms_opt_in": true
      },
      {
        "id": 112,
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "janedoe@example.com",
        "phone_1": "",
        "phone_2": "",
        "sms_opt_in": false
      }
    ],
    "lead_source": "apartments.com",
    "move_in_date": "1970-01-01",
    "created_at": "2019-01-01T04:55:55",
    "layouts": ["1-bedroom", "2-bedroom"],
    "listings": [
      {
        "funnel_unit_id": 123,
        "property_address": "123 First St",
        "property_internal_id": "AAAA"
      }
    ],
    "messages": [
      {
        "message": "Hi am i interested in seeing apt 2a.",
        "received_at": "2019-01-01T04:55:55",
        "message_type": ""
      }
    ],
    "third_party_vla_handling": false
  }
}

Usage Notes

When you receive this event, you can use it to:

  • Create new renter/prospect records in your CRM or Property Management System
  • Track lead sources and discovery channels
  • Store contact information and SMS opt-in preferences
  • Record layout preferences for matching with available units
  • Track initial messages and communication history

The sms_opt_in field in the people array indicates whether each person has consented to receive SMS messages, which is important for compliance with communication preferences.

What counts as a successful delivery: Funnel treats any 2xx HTTP status code as success — it does not check the response body at all, so returning any content (or none) with a 2xx status is sufficient. If your endpoint returns a non-2xx status or is unreachable, Funnel retries the delivery up to 2 more times (3 attempts total), waiting roughly 60 seconds and then 120 seconds before each retry, so your handler must be idempotent.

Migration to Webhooks v2

This legacy webhook is deprecated. For new integrations, we recommend using the modern webhooks v2 system, which provides:

  • Better event structure with consistent formatting
  • More granular events for different activities
  • A dedicated delivery pipeline — see the Webhooks Walkthrough for what's documented about its delivery behavior
  • Enhanced security features