ByteChef LogoByteChef
Components

Cal.com

A fully customizable scheduling software for individuals, businesses taking calls and developers building scheduling platforms where users meet users.

Categories: Communication

Type: calcom/v1


Connections

Version: 1

API Key Authorization

Properties

NameLabelTypeDescriptionRequired
tokenApi KeySTRINGCan be found in Settings -> Developer -> API keys.true

Triggers

Booking Canceled

Name: bookingCanceled

Triggers when a booking is canceled.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
bookerUrlSTRINGBooker URL.
titleSTRINGTitle of the booking.
lengthINTEGERLength of the booking.
typeSTRINGType of the booking.
additionalNotesSTRINGAdditional notes of the booking.
descriptionSTRINGDescription of the booking.
customInputsOBJECT
Properties {}
Custom inputs of the booking.
eventTypeIdINTEGERID of the event type of the booking.
userFieldsResponsesOBJECT
Properties {}
User field responses of the booking.
responsesOBJECT
Properties {{{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(name), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(email), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(location), {STRING(label), BOOLEAN(isHidden)}(title), {STRING(label), BOOLEAN(isHidden)}(notes), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(guests), {STRING(label), BOOLEAN(isHidden)}(rescheduleReason)}
Responses of the booking.
startTimeSTRINGStart time of the booking.
endTimeSTRINGEnd time of the booking.
organizerOBJECT
Properties {{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}(personRecord)}
Organizer of the booking.
attendeesARRAY
Items [{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}($personRecord)]
Attendees of the booking.
uidSTRINGUID of the booking.
bookingIdINTEGERID of the booking.
locationSTRINGLocation of the booking.
destinationCalendarARRAY
Items [{INTEGER(id), STRING(integration), STRING(externalId), STRING(primaryEmail), INTEGER(userId), INTEGER(eventTypeId), INTEGER(credentialId), INTEGER(delegationCredentialId), INTEGER(domainWideDelegationCredentialId)}($calendar)]
Destination calendar of the booking.
cancellationReasonSTRINGCancellation reason of the booking cancellation.
seatsPerTimeSlotINTEGERHow many seats are available in the booking timeslot.
seatsShowAttendeesBOOLEAN
Options true, false
Whether the seats show attendees.
iCalUIDSTRINGUID of the iCal.
iCalSequenceINTEGERSequence of the iCal.
hideOrganizerEmailBOOLEAN
Options true, false
Whether the organizer email is hidden.
customReplyToEmailSTRINGCustom reply to the email.
eventTitleSTRINGEvent title of the booking.
eventDescriptionSTRINGEvent description of the booking.
requiresConfirmationBOOLEAN
Options true, false
Whether booking requires confirmation.
priceINTEGERPrice of the booking.
currencySTRINGCurrency of the price of the booking.
statusSTRINGStatus of the booking
cancelledBySTRINGUser that cancelled the booking.

JSON Example

{
  "label" : "Booking Canceled",
  "name" : "bookingCanceled",
  "type" : "calcom/v1/bookingCanceled"
}

Booking Created

Name: bookingCreated

Triggers when a booking is created.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
bookerUrlSTRINGBooker URL.
titleSTRINGTitle of the booking.
startTimeSTRINGStart time of the booking.
endTimeSTRINGEnd time of the booking.
additionalNotesSTRINGAdditional notes of the booking.
typeSTRINGType of the booking.
descriptionSTRINGDescription of the booking.
eventTypeIdINTEGERID of the event type of the booking.
hideCalendarNotesBOOLEAN
Options true, false
Whether the calendar notes are hidden.
hideCalendarEventDetailsBOOLEAN
Options true, false
Whether the calendar event details are hidden.
hideOrganizerEmailBOOLEAN
Options true, false
Whether the organizer email is hidden.
schedulingTypeSTRINGScheduling type of the booking
seatsPerTimeSlotINTEGERHow many seats are available in the booking timeslot.
seatsShowAttendeesBOOLEAN
Options true, false
Whether the seats show attendees.
seatsShowAvailabilityCountBOOLEAN
Options true, false
Whether the seats show availability count.
customReplyToEmailSTRINGCustom reply to the email.
organizerOBJECT
Properties {{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}(personRecord)}
Organizer of the booking.
attendeesARRAY
Items [{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}($personRecord)]
Attendees of the booking.
customInputsOBJECT
Properties {}
Custom inputs of the booking.
responsesOBJECT
Properties {{{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(name), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(email), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(location), {STRING(label), BOOLEAN(isHidden)}(title), {STRING(label), BOOLEAN(isHidden)}(notes), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(guests), {STRING(label), BOOLEAN(isHidden)}(rescheduleReason)}
Responses of the booking.
userFieldsResponsesOBJECT
Properties {}
User field responses of the booking.
locationSTRINGLocation of the booking.
destinationCalendarARRAY
Items [{INTEGER(id), STRING(integration), STRING(externalId), STRING(primaryEmail), INTEGER(userId), INTEGER(eventTypeId), INTEGER(credentialId), INTEGER(delegationCredentialId), INTEGER(domainWideDelegationCredentialId)}($calendar)]
Destination calendar of the booking.
iCalUIDSTRINGUID of the iCal.
iCalSequenceINTEGERSequence of the iCal.
requiresConfirmationBOOLEAN
Options true, false
Whether booking requires confirmation.
oneTimePasswordSTRINGOne time password of the booking.
uidSTRINGUID of the booking.
conferenceDataOBJECT
Properties {{STRING(requestId)}(createRequest)}
Conference data of the booking.
appsStatusARRAY
Items [{STRING(appName), STRING(type), INTEGER(success), INTEGER(failures), [STRING($error)](errors), [STRING($warning)](warnings)}($app)]
Application status of the booking.
eventTitleSTRINGEvent title of the booking.
eventDescriptionSTRINGEvent description of the booking.
priceINTEGERPrice of the booking.
currencySTRINGCurrency of the price of the booking.
lengthINTEGERLength of the booking.
bookingIdINTEGERID of the booking.
metadataOBJECT
Properties {}
Metadata of the booking.
statusSTRINGStatus of the booking

JSON Example

{
  "label" : "Booking Created",
  "name" : "bookingCreated",
  "type" : "calcom/v1/bookingCreated"
}

Booking Ended

Name: bookingEnded

Triggers when a booking ends.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
typeSTRINGType of the meeting that ended.
titleSTRINGTitle of the meeting that ended.
startTimeSTRINGStart time of the booking.
endTimeSTRINGEnd time of the booking.
attendeesARRAY
Items [{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}($personRecord)]
Attendees of the booking.
organizerOBJECT
Properties {{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}(personRecord)}
Organizer of the booking.

JSON Example

{
  "label" : "Booking Ended",
  "name" : "bookingEnded",
  "type" : "calcom/v1/bookingEnded"
}

Booking Rescheduled

Name: bookingRescheduled

Triggers when a booking is rescheduled.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
bookerUrlSTRINGBooker URL.
titleSTRINGTitle of the booking.
startTimeSTRINGStart time of the booking.
endTimeSTRINGEnd time of the booking.
additionalNotesSTRINGAdditional notes of the booking.
typeSTRINGType of the booking.
descriptionSTRINGDescription of the booking.
eventTypeIdINTEGERID of the event type of the booking.
hideCalendarNotesBOOLEAN
Options true, false
Whether the calendar notes are hidden.
hideCalendarEventDetailsBOOLEAN
Options true, false
Whether the calendar event details are hidden.
hideOrganizerEmailBOOLEAN
Options true, false
Whether the organizer email is hidden.
schedulingTypeSTRINGScheduling type of the booking
seatsPerTimeSlotINTEGERHow many seats are available in the booking timeslot.
seatsShowAttendeesBOOLEAN
Options true, false
Whether the seats show attendees.
seatsShowAvailabilityCountBOOLEAN
Options true, false
Whether the seats show availability count.
customReplyToEmailSTRINGCustom reply to the email.
organizerOBJECT
Properties {{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}(personRecord)}
Organizer of the booking.
attendeesARRAY
Items [{INTEGER(id), STRING(name), STRING(email), STRING(username), STRING(timezone), {STRING(locale)}(language), STRING(timeFormat), INTEGER(utcOffset)}($personRecord)]
Attendees of the booking.
customInputsOBJECT
Properties {}
Custom inputs of the booking.
responsesOBJECT
Properties {{{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(name), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(email), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(location), {STRING(label), BOOLEAN(isHidden)}(title), {STRING(label), BOOLEAN(isHidden)}(notes), {{STRING(label), STRING(value), BOOLEAN(isHidden)}(responseValue)}(guests), {STRING(label), BOOLEAN(isHidden)}(rescheduleReason)}
Responses of the booking.
userFieldsResponsesOBJECT
Properties {}
User field responses of the booking.
locationSTRINGLocation of the booking.
destinationCalendarARRAY
Items [{INTEGER(id), STRING(integration), STRING(externalId), STRING(primaryEmail), INTEGER(userId), INTEGER(eventTypeId), INTEGER(credentialId), INTEGER(delegationCredentialId), INTEGER(domainWideDelegationCredentialId)}($calendar)]
Destination calendar of the booking.
iCalUIDSTRINGUID of the iCal.
iCalSequenceINTEGERSequence of the iCal.
requiresConfirmationBOOLEAN
Options true, false
Whether booking requires confirmation.
oneTimePasswordSTRINGOne time password of the booking.
uidSTRINGUID of the booking.
videoCallDataOBJECT
Properties {STRING(type), INTEGER(id), STRING(password), STRING(uri)}
Video call data of the booking.
rescheduledBySTRINGBooking rescheduled by user.
conferenceDataOBJECT
Properties {{STRING(requestId)}(createRequest)}
Conference data of the booking.
appsStatusARRAY
Items [{STRING(appName), STRING(type), INTEGER(success), INTEGER(failures), [STRING($error)](errors), [STRING($warning)](warnings)}($app)]
Application status of the booking.
eventTitleSTRINGEvent title of the booking.
eventDescriptionSTRINGEvent description of the booking.
priceINTEGERPrice of the booking.
currencySTRINGCurrency of the price of the booking.
lengthINTEGERLength of the booking.
bookingIdINTEGERID of the booking.
rescheduleIdINTEGERID of the rescheduled booking.
rescheduleUidSTRINGUID of the rescheduled booking.
rescheduleStartTimeSTRINGRescheduled start time of the booking.
rescheduleEndTimeSTRINGRescheduled end time of the booking.
metadataOBJECT
Properties {}
Metadata of the booking.
statusSTRINGStatus of the booking

JSON Example

{
  "label" : "Booking Rescheduled",
  "name" : "bookingRescheduled",
  "type" : "calcom/v1/bookingRescheduled"
}


Additional instructions