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