Skip to main content
When a contact books an appointment — whether through a booking widget, a manual entry in the calendar, or an automation — HoopAI sends an AppointmentCreate event to all configured webhook endpoints. You can use this event to sync appointments to external calendars, trigger confirmation emails, or update a CRM record in real time.

​
Payload

FieldTypeDescription
typestringAlways "AppointmentCreate"
locationIdstringSub-account ID the appointment belongs to
appointment.idstringUnique ID of the newly created appointment
appointment.addressstringMeeting location or URL (e.g., a video conference link)
appointment.titlestringDisplay name of the appointment
appointment.calendarIdstringID of the calendar this appointment was booked on
appointment.contactIdstringID of the contact who booked the appointment
appointment.groupIdstringID of the calendar group, if the calendar belongs to one
appointment.appointmentStatusstringCurrent status of the appointment (e.g., confirmed, cancelled, showed, noshow)
appointment.assignedUserIdstringID of the team member the appointment is assigned to
appointment.usersarrayList of user IDs associated with the appointment
appointment.notesstringInternal notes attached to the appointment
appointment.sourcestringHow the appointment was created (e.g., booking_widget, manual)
appointment.startTimestringISO 8601 start date and time of the appointment
appointment.endTimestringISO 8601 end date and time of the appointment
appointment.dateAddedstringISO 8601 timestamp when the appointment record was created
appointment.dateUpdatedstringISO 8601 timestamp when the appointment record was last updated

​
Example payload

{
  "type": "AppointmentCreate",
  "locationId": "0007BWpSzSwfiuSl0tR2",
  "appointment": {
    "id": "0007BWpSzSwfiuSl0tR2",
    "address": "https://example.com/meeting",
    "title": "Appointment with Hoop Dev team",
    "calendarId": "BqTwX8QFwXzpegMve9EQ",
    "contactId": "9NkT25Vor1v4aQatFsv2",
    "groupId": "9NkT25Vor1v4aQatFsv2",
    "appointmentStatus": "confirmed",
    "assignedUserId": "YlWd2wuCAZQzh2cH1fVZ",
    "users": ["YlWd2wuCAZQzh2cH1fVZ", "9NkT25Vor1v4aQatFsv2"],
    "notes": "Some dummy note",
    "source": "booking_widget",
    "startTime": "2023-09-25T16:00:00+05:30",
    "endTime": "2023-09-25T16:00:00+05:30",
    "dateAdded": "2023-09-25T16:00:00+05:30",
    "dateUpdated": "2023-09-25T16:00:00+05:30"
  }
}
Last modified on March 4, 2026