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