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