Morf Scheduling
Libraries
- Introduction
- Events
- Active Campaign
- Acuity
- Axle Health
- Butterfly Labs
- Calendly
- Customer Io
- Formsort
- Healthie
- Hubspot
- Intakeq
- Morf
- Push Json
- Segment
- Vital
- Actions
- Configuration (CEL)
- Integrations
Invitee
Event payload schema and trigger documentation for the Invitee from Calendly
{
"cancel_url": "https://calendly.com/cancellations/AAAAAAAAAAAAAAAA",
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T00:00:00Z",
"email": "test@example.com",
"event": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
"first_name": "John",
"invitee_scheduled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"last_name": "Doe",
"name": "John Doe",
"new_invitee": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/CCCCCCCCCCCCCCCC",
"no_show": {
"created_at": "2024-01-01T10:00:00Z",
"uri": "https://api.calendly.com/no_shows/AAAAAAAAAAAAAAAA"
},
"old_invitee": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/BBBBBBBBBBBBBBBB",
"payment": {
"amount": 50,
"currency": "USD",
"external_id": "ch_1234567890",
"provider": "stripe",
"successful": true,
"terms": "Payment due at time of booking"
},
"questions_and_answers": [
{
"answer": "Initial consultation",
"position": 1,
"question": "What is your reason for booking?"
},
{
"answer": "None",
"position": 2,
"question": "Do you have any special requirements?"
}
],
"reconfirmation": {
"confirmed_at": "2024-01-02T10:00:00Z",
"created_at": "2024-01-01T10:00:00Z"
},
"reschedule_url": "https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA",
"rescheduled": false,
"routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
"scheduled_event": {
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T09:00:00Z",
"end_time": "2024-01-01T10:30:00Z",
"event_guests": [
{
"created_at": "2024-01-01T09:00:00Z",
"email": "guest@example.com",
"updated_at": "2024-01-01T09:00:00Z"
}
],
"event_memberships": [
{
"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"user_email": "user@example.com",
"user_name": "John Doe"
}
],
"event_type": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
"invitees_counter": {
"active": 3,
"limit": 10,
"total": 5
},
"location": {
"additional_info": "Park in visitor parking",
"location": "123 Main St, Suite 100",
"type": "physical"
},
"meeting_notes_html": "<p>Discuss project timeline and deliverables</p>",
"meeting_notes_plain": "Discuss project timeline and deliverables",
"name": "15 Minute Meeting",
"start_time": "2024-01-01T10:00:00Z",
"status": "active",
"updated_at": "2024-01-01T09:00:00Z",
"uri": "https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2"
},
"scheduling_method": "direct",
"status": "active",
"text_reminder_number": "+1234567890",
"timezone": "America/New_York",
"tracking": {
"salesforce_uuid": "00Q1a000004WHchEAG",
"utm_campaign": "spring_sale",
"utm_content": "textad",
"utm_medium": "cpc",
"utm_source": "google",
"utm_term": "scheduling+software"
},
"updated_at": "2024-01-01T00:00:00Z",
"uri": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA"
}
{
"cancel_url": "URL that can be used to cancel the event",
"cancellation": {
"canceled_by": "URI reference to who cancelled the event",
"canceler_type": "Type of user who cancelled (host or invitee)",
"created_at": "When the cancellation occurred",
"reason": "Reason for cancellation"
},
"created_at": "The date and time the invitee was created",
"email": "The invitee's email address",
"event": "Event URL",
"first_name": "The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name",
"invitee_scheduled_by": "Reference to the user who scheduled on behalf of the invitee",
"last_name": "The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name",
"name": "The invitee's name (in human-readable format)",
"new_invitee": "Reference to the new invitee if this event was rescheduled",
"no_show": {
"created_at": "When the no-show was recorded",
"uri": "URI reference for the no-show record"
},
"old_invitee": "Reference to the previous invitee if this is a rescheduled event",
"payment": {
"amount": "The amount of the payment",
"currency": "The currency format that the payment is in (AUD, CAD, EUR, GBP, USD)",
"external_id": "Unique identifier for the payment",
"provider": "Payment provider (stripe or paypal)",
"successful": "Whether the payment was successful",
"terms": "Payment terms"
},
"questions_and_answers": "List of questions and answers provided by the invitee",
"reconfirmation": {
"confirmed_at": "When the event was reconfirmed",
"created_at": "When the reconfirmation was requested"
},
"reschedule_url": "URL that can be used to reschedule the event",
"rescheduled": "Indicates if the invitee has been rescheduled",
"routing_form_submission": "Reference to the routing form submission if this event was scheduled through a routing form",
"scheduled_event": {
"cancellation": {
"canceled_by": "URI reference to who cancelled the event",
"canceler_type": "Type of user who cancelled (host or invitee)",
"created_at": "When the cancellation occurred",
"reason": "Reason for cancellation"
},
"created_at": "When the event was created",
"end_time": "End time of the event",
"event_guests": "List of event guests",
"event_memberships": "List of event members",
"event_type": "Type of the event",
"invitees_counter": {
"active": "Number of active invitees",
"limit": "Maximum number of invitees allowed",
"total": "Total number of invitees"
},
"location": {
"additional_info": "Additional location information",
"location": "The location details",
"type": "The type of location (physical, virtual)"
},
"meeting_notes_html": "Meeting notes in HTML format",
"meeting_notes_plain": "Meeting notes in plain text",
"name": "The event name",
"start_time": "Start time of the event",
"status": "Current status of the event",
"updated_at": "When the event was last updated",
"uri": "Canonical reference (unique identifier) for the resource"
},
"scheduling_method": "Method used to schedule the event",
"status": "Indicates if the invitee is \"active\" or \"canceled\"",
"text_reminder_number": "The phone number to send text reminders to",
"timezone": "The timezone of the invitee",
"tracking": {
"salesforce_uuid": "Salesforce UUID for tracking",
"utm_campaign": "UTM campaign tracking parameter",
"utm_content": "UTM content tracking parameter",
"utm_medium": "UTM medium tracking parameter",
"utm_source": "UTM source tracking parameter",
"utm_term": "UTM term tracking parameter"
},
"updated_at": "The date and time the invitee was last updated",
"uri": "Canonical reference (unique identifier) for the invitee"
}
Events
Triggering Webhook Types
The following event types are associated with the Invitee event payload from Calendly.
Calendly Invitee Created
Calendly Invitee Canceled
Calendly Invitee No Show Created
Calendly Invitee No Show Deleted
{
"cancel_url": "https://calendly.com/cancellations/AAAAAAAAAAAAAAAA",
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T00:00:00Z",
"email": "test@example.com",
"event": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
"first_name": "John",
"invitee_scheduled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"last_name": "Doe",
"name": "John Doe",
"new_invitee": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/CCCCCCCCCCCCCCCC",
"no_show": {
"created_at": "2024-01-01T10:00:00Z",
"uri": "https://api.calendly.com/no_shows/AAAAAAAAAAAAAAAA"
},
"old_invitee": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/BBBBBBBBBBBBBBBB",
"payment": {
"amount": 50,
"currency": "USD",
"external_id": "ch_1234567890",
"provider": "stripe",
"successful": true,
"terms": "Payment due at time of booking"
},
"questions_and_answers": [
{
"answer": "Initial consultation",
"position": 1,
"question": "What is your reason for booking?"
},
{
"answer": "None",
"position": 2,
"question": "Do you have any special requirements?"
}
],
"reconfirmation": {
"confirmed_at": "2024-01-02T10:00:00Z",
"created_at": "2024-01-01T10:00:00Z"
},
"reschedule_url": "https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA",
"rescheduled": false,
"routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
"scheduled_event": {
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T09:00:00Z",
"end_time": "2024-01-01T10:30:00Z",
"event_guests": [
{
"created_at": "2024-01-01T09:00:00Z",
"email": "guest@example.com",
"updated_at": "2024-01-01T09:00:00Z"
}
],
"event_memberships": [
{
"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"user_email": "user@example.com",
"user_name": "John Doe"
}
],
"event_type": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
"invitees_counter": {
"active": 3,
"limit": 10,
"total": 5
},
"location": {
"additional_info": "Park in visitor parking",
"location": "123 Main St, Suite 100",
"type": "physical"
},
"meeting_notes_html": "<p>Discuss project timeline and deliverables</p>",
"meeting_notes_plain": "Discuss project timeline and deliverables",
"name": "15 Minute Meeting",
"start_time": "2024-01-01T10:00:00Z",
"status": "active",
"updated_at": "2024-01-01T09:00:00Z",
"uri": "https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2"
},
"scheduling_method": "direct",
"status": "active",
"text_reminder_number": "+1234567890",
"timezone": "America/New_York",
"tracking": {
"salesforce_uuid": "00Q1a000004WHchEAG",
"utm_campaign": "spring_sale",
"utm_content": "textad",
"utm_medium": "cpc",
"utm_source": "google",
"utm_term": "scheduling+software"
},
"updated_at": "2024-01-01T00:00:00Z",
"uri": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA"
}
{
"cancel_url": "URL that can be used to cancel the event",
"cancellation": {
"canceled_by": "URI reference to who cancelled the event",
"canceler_type": "Type of user who cancelled (host or invitee)",
"created_at": "When the cancellation occurred",
"reason": "Reason for cancellation"
},
"created_at": "The date and time the invitee was created",
"email": "The invitee's email address",
"event": "Event URL",
"first_name": "The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name",
"invitee_scheduled_by": "Reference to the user who scheduled on behalf of the invitee",
"last_name": "The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name",
"name": "The invitee's name (in human-readable format)",
"new_invitee": "Reference to the new invitee if this event was rescheduled",
"no_show": {
"created_at": "When the no-show was recorded",
"uri": "URI reference for the no-show record"
},
"old_invitee": "Reference to the previous invitee if this is a rescheduled event",
"payment": {
"amount": "The amount of the payment",
"currency": "The currency format that the payment is in (AUD, CAD, EUR, GBP, USD)",
"external_id": "Unique identifier for the payment",
"provider": "Payment provider (stripe or paypal)",
"successful": "Whether the payment was successful",
"terms": "Payment terms"
},
"questions_and_answers": "List of questions and answers provided by the invitee",
"reconfirmation": {
"confirmed_at": "When the event was reconfirmed",
"created_at": "When the reconfirmation was requested"
},
"reschedule_url": "URL that can be used to reschedule the event",
"rescheduled": "Indicates if the invitee has been rescheduled",
"routing_form_submission": "Reference to the routing form submission if this event was scheduled through a routing form",
"scheduled_event": {
"cancellation": {
"canceled_by": "URI reference to who cancelled the event",
"canceler_type": "Type of user who cancelled (host or invitee)",
"created_at": "When the cancellation occurred",
"reason": "Reason for cancellation"
},
"created_at": "When the event was created",
"end_time": "End time of the event",
"event_guests": "List of event guests",
"event_memberships": "List of event members",
"event_type": "Type of the event",
"invitees_counter": {
"active": "Number of active invitees",
"limit": "Maximum number of invitees allowed",
"total": "Total number of invitees"
},
"location": {
"additional_info": "Additional location information",
"location": "The location details",
"type": "The type of location (physical, virtual)"
},
"meeting_notes_html": "Meeting notes in HTML format",
"meeting_notes_plain": "Meeting notes in plain text",
"name": "The event name",
"start_time": "Start time of the event",
"status": "Current status of the event",
"updated_at": "When the event was last updated",
"uri": "Canonical reference (unique identifier) for the resource"
},
"scheduling_method": "Method used to schedule the event",
"status": "Indicates if the invitee is \"active\" or \"canceled\"",
"text_reminder_number": "The phone number to send text reminders to",
"timezone": "The timezone of the invitee",
"tracking": {
"salesforce_uuid": "Salesforce UUID for tracking",
"utm_campaign": "UTM campaign tracking parameter",
"utm_content": "UTM content tracking parameter",
"utm_medium": "UTM medium tracking parameter",
"utm_source": "UTM source tracking parameter",
"utm_term": "UTM term tracking parameter"
},
"updated_at": "The date and time the invitee was last updated",
"uri": "Canonical reference (unique identifier) for the invitee"
}
Schema Field Details
Canonical reference (unique identifier) for the invitee
uri
"https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA"
The invitee’s email address
email
"test@example.com"
The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name
first_name
"John"
The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name
last_name
"Doe"
The invitee’s name (in human-readable format)
name
"John Doe"
Indicates if the invitee is “active” or “canceled”
status
"active"
List of questions and answers provided by the invitee
questions_and_answers
[
{
"answer": "Initial consultation",
"position": 1,
"question": "What is your reason for booking?"
},
{
"answer": "None",
"position": 2,
"question": "Do you have any special requirements?"
}
]
Mapped array of: The question text
questions_and_answers.map(x, x.question)
[
"What topics would you like to discuss?"
]
Mapped array of: The answer provided by the invitee
questions_and_answers.map(x, x.answer)
[
"Project planning and timelines"
]
Mapped array of: The order position of this question
questions_and_answers.map(x, x.position)
[
1
]
The timezone of the invitee
timezone
"America/New_York"
Event URL
event
"https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA"
The date and time the invitee was created
created_at
"2024-01-01T00:00:00Z"
The date and time the invitee was last updated
updated_at
"2024-01-01T00:00:00Z"
Tracking information for the invitee
tracking
{
"salesforce_uuid": "00Q1a000004WHchEAG",
"utm_campaign": "spring_sale",
"utm_content": "textad",
"utm_medium": "cpc",
"utm_source": "google",
"utm_term": "scheduling+software"
}
UTM campaign tracking parameter
tracking.utm_campaign
"spring_sale"
UTM source tracking parameter
tracking.utm_source
"google"
UTM medium tracking parameter
tracking.utm_medium
"cpc"
UTM content tracking parameter
tracking.utm_content
"textad"
UTM term tracking parameter
tracking.utm_term
"scheduling+software"
Salesforce UUID for tracking
tracking.salesforce_uuid
"00Q1a000004WHchEAG"
The phone number to send text reminders to
text_reminder_number
"+1234567890"
Indicates if the invitee has been rescheduled
rescheduled
false
Reference to the previous invitee if this is a rescheduled event
old_invitee
"https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/BBBBBBBBBBBBBBBB"
Reference to the new invitee if this event was rescheduled
new_invitee
"https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/CCCCCCCCCCCCCCCC"
URL that can be used to cancel the event
cancel_url
"https://calendly.com/cancellations/AAAAAAAAAAAAAAAA"
URL that can be used to reschedule the event
reschedule_url
"https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA"
Reference to the routing form submission if this event was scheduled through a routing form
routing_form_submission
"https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA"
Cancellation details if the event was cancelled
cancellation
{
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
}
URI reference to who cancelled the event
cancellation.canceled_by
"https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
Reason for cancellation
cancellation.reason
"Schedule conflict"
Type of user who cancelled (host or invitee)
cancellation.canceler_type
"host"
When the cancellation occurred
cancellation.created_at
"2024-01-01T09:00:00Z"
Payment details if the event required payment
payment
{
"amount": "100.00",
"currency": "USD",
"payment_method": "credit_card",
"status": "completed"
}
Unique identifier for the payment
payment.external_id
"ch_1234567890"
Payment provider (stripe or paypal)
payment.provider
"stripe"
The amount of the payment
payment.amount
50
The currency format that the payment is in (AUD, CAD, EUR, GBP, USD)
payment.currency
"USD"
Payment terms
payment.terms
"Payment due at time of booking"
Whether the payment was successful
payment.successful
true
No-show details if the invitee was marked as a no-show
no_show
{
"marked_at": "2024-01-01T09:00:00Z",
"marked_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"reason": "Invitee did not show up"
}
URI reference for the no-show record
no_show.uri
"https://api.calendly.com/no_shows/AAAAAAAAAAAAAAAA"
When the no-show was recorded
no_show.created_at
"2024-01-01T10:00:00Z"
Reconfirmation details if the event required reconfirmation
reconfirmation
{
"confirmed_at": "2024-01-02T09:00:00Z",
"created_at": "2024-01-01T09:00:00Z"
}
When the reconfirmation was requested
reconfirmation.created_at
"2024-01-01T10:00:00Z"
When the event was reconfirmed
reconfirmation.confirmed_at
"2024-01-02T10:00:00Z"
Method used to schedule the event
scheduling_method
"direct"
Reference to the user who scheduled on behalf of the invitee
invitee_scheduled_by
"https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
Details about the scheduled event
scheduled_event
{
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T09:00:00Z",
"end_time": "2024-01-01T10:30:00Z",
"event_guests": [
{
"created_at": "2024-01-01T09:00:00Z",
"email": "guest@example.com",
"updated_at": "2024-01-01T09:00:00Z"
}
],
"event_memberships": [
{
"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"user_email": "user@example.com",
"user_name": "John Doe"
}
],
"event_type": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
"invitees_counter": {
"active": 3,
"limit": 10,
"total": 5
},
"location": {
"additional_info": "Park in visitor parking",
"location": "123 Main St, Suite 100",
"type": "physical"
},
"meeting_notes_html": "<p>Discuss project timeline and deliverables</p>",
"meeting_notes_plain": "Discuss project timeline and deliverables",
"name": "30 Minute Meeting",
"start_time": "2024-01-01T10:00:00Z",
"status": "active",
"updated_at": "2024-01-01T09:00:00Z",
"uri": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA"
}
Canonical reference (unique identifier) for the resource
scheduled_event.uri
"https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2"
The event name
scheduled_event.name
"15 Minute Meeting"
Meeting notes in plain text
scheduled_event.meeting_notes_plain
"Discuss project timeline and deliverables"
Meeting notes in HTML format
scheduled_event.meeting_notes_html
"<p>Discuss project timeline and deliverables</p>"
Current status of the event
scheduled_event.status
"active"
Start time of the event
scheduled_event.start_time
"2024-01-01T10:00:00Z"
End time of the event
scheduled_event.end_time
"2024-01-01T10:30:00Z"
Type of the event
scheduled_event.event_type
"https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA"
Location details for the event
scheduled_event.location
{
"additional_info": "Park in visitor parking",
"location": "123 Main St, Suite 100",
"type": "physical"
}
The type of location (physical, virtual)
scheduled_event.location.type
"physical"
The location details
scheduled_event.location.location
"123 Main St, Suite 100"
Additional location information
scheduled_event.location.additional_info
"Park in visitor parking"
Counter for event invitees
scheduled_event.invitees_counter
{
"active": 3,
"limit": 10,
"total": 5
}
Total number of invitees
scheduled_event.invitees_counter.total
5
Number of active invitees
scheduled_event.invitees_counter.active
3
Maximum number of invitees allowed
scheduled_event.invitees_counter.limit
10
When the event was created
scheduled_event.created_at
"2024-01-01T09:00:00Z"
When the event was last updated
scheduled_event.updated_at
"2024-01-01T09:00:00Z"
List of event members
scheduled_event.event_memberships
[
{
"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"user_email": "user@example.com",
"user_name": "John Doe"
}
]
Mapped array of: URI reference to the user
scheduled_event.event_memberships.map(x, x.user)
[
"https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
]
Mapped array of: Email address of the user
scheduled_event.event_memberships.map(x, x.user_email)
[
"user@example.com"
]
Mapped array of: Name of the user
scheduled_event.event_memberships.map(x, x.user_name)
[
"John Doe"
]
List of event guests
scheduled_event.event_guests
[
{
"created_at": "2024-01-01T09:00:00Z",
"email": "guest@example.com",
"updated_at": "2024-01-01T09:00:00Z"
}
]
Mapped array of: Email address of the guest
scheduled_event.event_guests.map(x, x.email)
[
"guest@example.com"
]
Mapped array of: When the guest was added
scheduled_event.event_guests.map(x, x.created_at)
[
"2024-01-01T09:00:00Z"
]
Mapped array of: When the guest was last updated
scheduled_event.event_guests.map(x, x.updated_at)
[
"2024-01-01T09:00:00Z"
]
Cancellation details if the event was cancelled
scheduled_event.cancellation
{
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
}
URI reference to who cancelled the event
scheduled_event.cancellation.canceled_by
"https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
Reason for cancellation
scheduled_event.cancellation.reason
"Schedule conflict"
Type of user who cancelled (host or invitee)
scheduled_event.cancellation.canceler_type
"host"
When the cancellation occurred
scheduled_event.cancellation.created_at
"2024-01-01T09:00:00Z"
{
"cancel_url": "https://calendly.com/cancellations/AAAAAAAAAAAAAAAA",
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T00:00:00Z",
"email": "test@example.com",
"event": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
"first_name": "John",
"invitee_scheduled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"last_name": "Doe",
"name": "John Doe",
"new_invitee": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/CCCCCCCCCCCCCCCC",
"no_show": {
"created_at": "2024-01-01T10:00:00Z",
"uri": "https://api.calendly.com/no_shows/AAAAAAAAAAAAAAAA"
},
"old_invitee": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/BBBBBBBBBBBBBBBB",
"payment": {
"amount": 50,
"currency": "USD",
"external_id": "ch_1234567890",
"provider": "stripe",
"successful": true,
"terms": "Payment due at time of booking"
},
"questions_and_answers": [
{
"answer": "Initial consultation",
"position": 1,
"question": "What is your reason for booking?"
},
{
"answer": "None",
"position": 2,
"question": "Do you have any special requirements?"
}
],
"reconfirmation": {
"confirmed_at": "2024-01-02T10:00:00Z",
"created_at": "2024-01-01T10:00:00Z"
},
"reschedule_url": "https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA",
"rescheduled": false,
"routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
"scheduled_event": {
"cancellation": {
"canceled_by": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"canceler_type": "host",
"created_at": "2024-01-01T09:00:00Z",
"reason": "Schedule conflict"
},
"created_at": "2024-01-01T09:00:00Z",
"end_time": "2024-01-01T10:30:00Z",
"event_guests": [
{
"created_at": "2024-01-01T09:00:00Z",
"email": "guest@example.com",
"updated_at": "2024-01-01T09:00:00Z"
}
],
"event_memberships": [
{
"user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
"user_email": "user@example.com",
"user_name": "John Doe"
}
],
"event_type": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
"invitees_counter": {
"active": 3,
"limit": 10,
"total": 5
},
"location": {
"additional_info": "Park in visitor parking",
"location": "123 Main St, Suite 100",
"type": "physical"
},
"meeting_notes_html": "<p>Discuss project timeline and deliverables</p>",
"meeting_notes_plain": "Discuss project timeline and deliverables",
"name": "15 Minute Meeting",
"start_time": "2024-01-01T10:00:00Z",
"status": "active",
"updated_at": "2024-01-01T09:00:00Z",
"uri": "https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2"
},
"scheduling_method": "direct",
"status": "active",
"text_reminder_number": "+1234567890",
"timezone": "America/New_York",
"tracking": {
"salesforce_uuid": "00Q1a000004WHchEAG",
"utm_campaign": "spring_sale",
"utm_content": "textad",
"utm_medium": "cpc",
"utm_source": "google",
"utm_term": "scheduling+software"
},
"updated_at": "2024-01-01T00:00:00Z",
"uri": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA"
}
{
"cancel_url": "URL that can be used to cancel the event",
"cancellation": {
"canceled_by": "URI reference to who cancelled the event",
"canceler_type": "Type of user who cancelled (host or invitee)",
"created_at": "When the cancellation occurred",
"reason": "Reason for cancellation"
},
"created_at": "The date and time the invitee was created",
"email": "The invitee's email address",
"event": "Event URL",
"first_name": "The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name",
"invitee_scheduled_by": "Reference to the user who scheduled on behalf of the invitee",
"last_name": "The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name",
"name": "The invitee's name (in human-readable format)",
"new_invitee": "Reference to the new invitee if this event was rescheduled",
"no_show": {
"created_at": "When the no-show was recorded",
"uri": "URI reference for the no-show record"
},
"old_invitee": "Reference to the previous invitee if this is a rescheduled event",
"payment": {
"amount": "The amount of the payment",
"currency": "The currency format that the payment is in (AUD, CAD, EUR, GBP, USD)",
"external_id": "Unique identifier for the payment",
"provider": "Payment provider (stripe or paypal)",
"successful": "Whether the payment was successful",
"terms": "Payment terms"
},
"questions_and_answers": "List of questions and answers provided by the invitee",
"reconfirmation": {
"confirmed_at": "When the event was reconfirmed",
"created_at": "When the reconfirmation was requested"
},
"reschedule_url": "URL that can be used to reschedule the event",
"rescheduled": "Indicates if the invitee has been rescheduled",
"routing_form_submission": "Reference to the routing form submission if this event was scheduled through a routing form",
"scheduled_event": {
"cancellation": {
"canceled_by": "URI reference to who cancelled the event",
"canceler_type": "Type of user who cancelled (host or invitee)",
"created_at": "When the cancellation occurred",
"reason": "Reason for cancellation"
},
"created_at": "When the event was created",
"end_time": "End time of the event",
"event_guests": "List of event guests",
"event_memberships": "List of event members",
"event_type": "Type of the event",
"invitees_counter": {
"active": "Number of active invitees",
"limit": "Maximum number of invitees allowed",
"total": "Total number of invitees"
},
"location": {
"additional_info": "Additional location information",
"location": "The location details",
"type": "The type of location (physical, virtual)"
},
"meeting_notes_html": "Meeting notes in HTML format",
"meeting_notes_plain": "Meeting notes in plain text",
"name": "The event name",
"start_time": "Start time of the event",
"status": "Current status of the event",
"updated_at": "When the event was last updated",
"uri": "Canonical reference (unique identifier) for the resource"
},
"scheduling_method": "Method used to schedule the event",
"status": "Indicates if the invitee is \"active\" or \"canceled\"",
"text_reminder_number": "The phone number to send text reminders to",
"timezone": "The timezone of the invitee",
"tracking": {
"salesforce_uuid": "Salesforce UUID for tracking",
"utm_campaign": "UTM campaign tracking parameter",
"utm_content": "UTM content tracking parameter",
"utm_medium": "UTM medium tracking parameter",
"utm_source": "UTM source tracking parameter",
"utm_term": "UTM term tracking parameter"
},
"updated_at": "The date and time the invitee was last updated",
"uri": "Canonical reference (unique identifier) for the invitee"
}