v7
latestOpenAPI 3.1.02026-08-0431138164.3 KBCalendar Event Webhook
Whenever a calendar event is created, cancelled, or updated, we will post it back to your registered webhook.
Webhooks can be registered at the organization level or the property level. Please reach out to the EliseAI support team to register your webhooks.
This is the list of possible update types:
- AppointmentScheduled: Posted whenever a new appointment is scheduled
- AppointmentCancelled: Posted whenever an appointment is cancelled
- AppointmentShow: Posted whenever a prospect shows up for their appointment
- AppointmentNoShow: Posted whenever a prospect doesn't show up for their appointment
- AgentUpdated: Posted whenever the assigned leasing agent for an appointment is changed
Calendar events will include:
- event_id: Unique identifier for the event
- type: The type of event that occurred
- event_date: Date and time of the event
- calendar_event_id: Elise identifier for the calendar event
- elise_property_id: Elise identifier for the property
- external_property_id: External identifier for the property
- elise_prospect_id: Elise identifier for the prospect
- external_prospect_id: External identifier for the prospect
Additional fields based on the type of event:
- AppointmentScheduled:
- start_time: The start time of the appointment
- end_time: The end time of the appointment
- tour_type: The type of tour
- leasing_agent_email: The email of the leasing agent
- leasing_agent_app_user_id: The ID of the leasing agent's app user
- AppointmentCancelled:
- start_time: The start time of the appointment
- end_time: The end time of the appointment
- tour_type: The type of tour
- AppointmentShow:
- show_time: The time the prospect showed up for their appointment
- start_time: The start time of the appointment
- end_time: The end time of the appointment
- tour_type: The type of tour
- unit_ids: The IDs of the units that were shown
- unit_numbers: The numbers of the units that were shown
- AppointmentNoShow:
- no_show_time: The time the prospect didn't show up for their appointment
- start_time: The start time of the appointment
- end_time: The end time of the appointment
- tour_type: The type of tour
- AgentUpdated:
- old_agent_user_id: The ID of the old leasing agent
- old_agent_email: The email of the old leasing agent
- new_agent_user_id: The ID of the new leasing agent
- new_agent_email: The email of the new leasing agent
- start_time: The start time of the appointment
- end_time: The end time of the appointment
- tour_type: The type of tour
postWebhookcalendar_event
Payload
Response
Successful Response
{"stackTrail":"webhooks:calendar_event:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}