Prospect Update Webhooks

renter.created

Webhook when renter is created in Funnel

{
    "event": "renter.created",
    "data": {
        "funnel_renter_id": 456678,
        "funnel_community_id": 1234,
        "status": "Prospect",
        "people": [
            {
                "first_name": "John",
                "last_name": "Doe",
                "email": "johndoe@example.com",
                "phone_1": "510-555-4567",
                "phone_2": "",
                "sms_opt_in": true
            },
            {
                "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": "ILS"
            }
        ]
    }
}

renter.status-change

Webhook when renter status changes

{
    "event": "renter.status-change",
    "data": {
        "funnel_renter_id": 456678,
        "funnel_team_id": 1234,
        "status": "Applicant"
    }
}

appointment.updated

Webhook when an appointment is created or updated

When an appointment is created or updated in Funnel, a webhook will be sent with the following structure:

{
     "event": "appointment.updated",
     "data": {
         "funnel_renter_id": 456,
         "funnel_tour_id": 879,
         "funnel_community_id": 123,
         "pms_unit_ids": ["123", "456"],
         "tour_type": "Guided",
         "start": "2021-08-01 15:00:00",
         "end": "2021-08-01 15:30:00",
         "status": "completed"
    }
}

The status field can have one of the following values:

• completed
• no-show
• cancelled
• unknown