Lead Webhook

Funnel will submit a POST request to your specified webhook each time a lead is created, as well as whenever the lead is updated, such as if they contact another listing.

The request will include a JSON payload in it’s body that looks like the following:

{
    "nestio_client_id": 456678,
    "nestio_team_id": 1234,
    "people": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "email": "johndoe@example.com",
            "phone_1": "510-555-4567",
            "phone_2": ""
        },
        {
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "janedoe@example.com",
            "phone_1": "",
            "phone_2": ""
        }
    ],
    "lead_source": "streeteasy",
    "move_in_date": "1970-01-01",
    "created_at": "2019-01-01T04:55:55",
    "listings": [
        {
            "nestio_unit_id": 123,
            "property_address": "123 First St",
            "property_internal_id": "AAAA",
            "unit_number": "2A",
            "unit_internal_id": "XXXX"
        }
    ],
    "messages": [
        {
            "message": "Hi am i interested in seeing apt 2a.",
            "received_at": "2019-01-01T04:55:55"
        }
    ],
    "agents": [
        {
            "name": "Dave Agently",
            "email": "dave@agently.com",
            "nestio_agent_id": "2"
        }
    ]
}

Body Parameters

• nestio_client_id - The unique ID for this lead assigned by Funnel.
• nestio_team_id - The unique ID of the company team to which this client was assigned.
• people
  • List of people of associated with the contact
  • Person object keys
    • first_name - String field for the persons’s first name.
    • last_name - String field for the persons’s last name.
    • email - String field for the persons’s email.
    • phone_1 - String field for the person’s primary phone number.
    • phone_2 - String field for the person’s secondary phone number.
• lead_source - String field for the way the client became a lead for your property. (Use name values from Discovery Sources)
• move_in_date - Date field move-in date, if available.
• created_at - The datetime the lead the was initially created.
• listings
  • A list of listings the lead has expressed interest in.
  • Listing object keys
    • nestio_unit_id - The ID of the unit, assigned by Funnel.
    • property_address - The address of the property that the listing is in.
    • property_internal_id - If you have provided Funnel with identifiers for your properties, that value will be included here.
    • unit_number - The unit number of the listing. Note that in the event that the ILS has only provided a Property and not a unit, this will not be included.
    • unit_internal_id - If you have provided Funnel with identifiers for your units, that value will be included here.
• messages
  • Any messages the lead has sent.
  • Message object keys
    • message - The text of the message.
    • received_at - Datetime of when the message was received.
• agents
  • Any agents assigned to the lead.
  • Agent object keys
    • name - The agent’s name.
    • email - The agent’s email.
    • nestio_agent_id - The unique ID of the agent.