Compartilhar via


Calendly (Preview)

Calendly's connector empowers you to automate scheduled events, boosting productivity and optimizing efficiency through automated workflows.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Calendly Support
URL https://help.calendly.com/hc/en-us
Email support@calendly.com
Connector Metadata
Publisher Calendly
Website https://calendly.com
Privacy policy https://calendly.com/privacy
Categories Productivity

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Personal Access Token securestring The Personal Access Token for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Invitee No Show

Marks an Invitee as a No Show.

Delete Invitee No Show

Undoes marking an Invitee as a No Show

Get Event Type

Returns information about a specified Event Type.

Get Event Types

Returns all Event Types associated with your organization.

Create Invitee No Show

Marks an Invitee as a No Show.

Parameters

Name Key Required Type Description
Invitee URI
invitee True string

URI of the invitee who is being marked as No Show for a scheduled event

Returns

Name Path Type Description
No Show URI
resource.uri string

Canonical reference (unique identifier) for the no show

Invitee URI
resource.invitee string

Canonical reference (unique identifier) for the associated Invitee

Created At
resource.created_at string

The moment when the no show was created

Delete Invitee No Show

Undoes marking an Invitee as a No Show

Parameters

Name Key Required Type Description
Invitee No Show UUID
uuid True string

UUID of the invitee whose No Show record is being removed

Returns

No Show successfully deleted

204
string

Get Event Type

Returns information about a specified Event Type.

Parameters

Name Key Required Type Description
Event Type UUID
uuid True string

UUID of the Event Type being requested

Returns

Name Path Type Description
resource
resource EventType

Get Event Types

Returns all Event Types associated with your organization.

Parameters

Name Key Required Type Description
Active
active boolean

Return only active event types if true, only inactive if false, or all event types if this parameter is omitted.

Count
count integer

The number of rows to return.

Page Token
page_token string

The token to pass to get the next or previous portion of the collection.

Admin Managed
admin_managed boolean

Return only admin managed event types if true, exclude admin managed event types if false, or include all event types if this parameter is omitted.

Returns

Name Path Type Description
collection
collection array of EventType

collection

Pagination Count
pagination.count integer

The number of rows to return.

Next Page URI
pagination.next_page string

URI to return the next page of an ordered list ("null" indicates no additional results are available).

Previous Page URI
pagination.previous_page string

URI to return the previous page of an ordered list ("null" indicates no additional results are available).

Next Page Token
pagination.next_page_token string

Token to return the next page of an ordered list ("null" indicates no additional results are available).

Previous Page Token
pagination.previous_page_token string

Token to return the previous page of an ordered list ("null" indicates no additional results are available).

Triggers

Create Webhook Subscription (Invitee)

Create a Webhook Subscription for an Organization that is triggered when an event is scheduled or canceled.

Create Webhook Subscription (Routing Form Submission)

Create a Webhook Subscription for an Organization that is triggered when a routing form is submitted.

Create Webhook Subscription (Invitee)

Create a Webhook Subscription for an Organization that is triggered when an event is scheduled or canceled.

Parameters

Name Key Required Type Description
events
events True array of string

events

Returns

Name Path Type Description
Webhook Created At
created_at string

The moment when the webhook was created (e.g. "2020-01-02T03:04:05.678123Z").

Webhook Creator URI
created_by string

A reference to the user who created the webhook subscription.

Webhook Event
event string

The event that caused the webhook to fire.

Cancel Event URL
payload.cancel_url string

Link to cancelling the event for the invitee.

Invitee Created At
payload.created_at string

The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z").

Invitee Email
payload.email string

The invitee's email address.

Event URI
payload.event string

A reference to the event.

Invitee Name
payload.name string

The invitee's name.

Invitee First Name
payload.first_name 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. Null when event type is configured to use a single field for name.

Invitee Last Name
payload.last_name 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. Null when event type is configured to use a single field for name.

New Invitee URI
payload.new_invitee string

Link to new invitee, after reschedule.

Old Invitee URI
payload.old_invitee string

Reference to old Invitee instance that got rescheduled.

A collection of the invitee's responses to questions on the event booking confirmation form
payload.questions_and_answers array of object

A collection of the invitee's responses to questions on the event booking confirmation form.

Question
payload.questions_and_answers.question string

A question on the invitee's booking form.

Answer
payload.questions_and_answers.answer string

The invitee's answer to the question.

Question Position
payload.questions_and_answers.position number

The position of the question in relation to others on the booking form.

Reschedule Event URL
payload.reschedule_url string

Link to rescheduling the event for the invitee.

Invitee Rescheduled?
payload.rescheduled boolean

rescheduled

Invitee Status
payload.status string

status

Invitee Text Reminder Number
payload.text_reminder_number string

text_reminder_number

Invitee Timezone
payload.timezone string

timezone

UTM Campaign
payload.tracking.utm_campaign string

The UTM parameter used to track a campaign.

UTM Source
payload.tracking.utm_source string

The UTM parameter that identifies the source (platform where the traffic originates).

UTM Medium
payload.tracking.utm_medium string

The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code).

UTM Content
payload.tracking.utm_content string

UTM content tracking parameter.

UTM Term
payload.tracking.utm_term string

The UTM parameter used to track keyword.

Salesforce UUID
payload.tracking.salesforce_uuid string

The Salesforce record unique identifier.

Invitee URI
payload.uri string

Canonical reference (unique identifier) for the invitee.

Routing Form Submission URI
payload.routing_form_submission string

Reference to a routing form submission that redirected the invitee to a booking page.

scheduled_event
payload.scheduled_event ScheduledEvent
cancellation
payload.cancellation Cancellation

Provides data pertaining to the cancellation of the Event

payment
payload.payment Payment

Invitee payment

no_show
payload.no_show NoShow

Provides data pertaining to the associated no show for the Invitee.

reconfirmation
payload.reconfirmation Reconfirmation

Assuming reconfirmation is enabled for the event type, when reconfirmation is requested this object is present with a created_at that reflects when the reconfirmation notification was sent. Once the invitee has reconfirmed the confirmed_at attribute will change from null to a timestamp that reflects when they took action.

Create Webhook Subscription (Routing Form Submission)

Create a Webhook Subscription for an Organization that is triggered when a routing form is submitted.

Parameters

Name Key Required Type Description
events
events True array of string

events

Returns

Name Path Type Description
Webhook Created At
created_at string

The moment when the webhook was created (e.g. "2020-01-02T03:04:05.678123Z").

Webhook Creator URI
created_by string

A reference to the user who created the webhook subscription.

Webhook Event
event string

The event that caused the webhook to fire.

Routing Form Submission URI
payload.uri string

Canonical reference (unique identifier) for the routing form submission.

Routing Form URI
payload.routing_form string

The URI of the routing form that's associated with the submission.

questions_and_answers
payload.questions_and_answers array of object

questions_and_answers

Question UUID
payload.questions_and_answers.question_uuid string

Unique identifier for the routing form question.

Question
payload.questions_and_answers.question string

Question name (in human-readable format).

Answer
payload.questions_and_answers.answer string

Answer provided by the respondent when the form was submitted.

UTM Campaign
payload.tracking.utm_campaign string

The UTM parameter used to track a campaign.

UTM Source
payload.tracking.utm_source string

The UTM parameter that identifies the source (platform where the traffic originates).

UTM Medium
payload.tracking.utm_medium string

The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code).

UTM Content
payload.tracking.utm_content string

UTM content tracking parameter.

UTM Term
payload.tracking.utm_term string

The UTM parameter used to track keyword.

Salesforce UUID
payload.tracking.salesforce_uuid string

The Salesforce record unique identifier.

Result Type
payload.result.type string

Indicates if the routing form submission resulted in a custom message, event type, or external URL.

Submitter URI
payload.submitter string

The reference to the Invitee resource when routing form submission results in a scheduled meeting.

Submitter Type
payload.submitter_type string

Type of the respondent resource that submitted the form and scheduled a meeting.

Routing Form Submission Created At
payload.created_at string

The moment the routing form was submitted.

Routing Form Submission Updated At
payload.updated_at string

The moment when the routing form submission was last updated.

Definitions

ScheduledEvent

Name Path Type Description
Event URI
uri uri

Canonical reference (unique identifier) for the resource.

Event Name
name string

The event name.

Event Status
status string

Indicates if the event is "active" or "canceled".

Event Start Time
start_time date-time

The moment the event was scheduled to start in UTC time (e.g. "2020-01-02T03:04:05.678123Z").

Event End Time
end_time date-time

The moment the event was scheduled to end in UTC time (e.g. "2020-01-02T03:04:05.678123Z")

Event Type URI
event_type uri

The event type associated with this event

location
location Location

The polymorphic base type for an event location that Calendly supports

Total Invitees
invitees_counter.total number

Total invitees for an event, including invitees that have canceled

Total Active Invitees
invitees_counter.active number

Total invitees for an event that have not canceled.

Event Max Invitees
invitees_counter.limit number

Maximum number of active invitees that can book the event.

Event Created At
created_at date-time

The moment when the event was created (e.g. "2020-01-02T03:04:05.678123Z")

Event Updated At
updated_at date-time

The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")

event_memberships
event_memberships array of object

Event membership list

Event Member URI
event_memberships.user uri

Canonical reference (unique identifier) for the user.

Event Member Email
event_memberships.user_email email

The user's email address.

event_guests
event_guests array of Guest

Additional people added to an event by an invitee

cancellation
cancellation Cancellation

Provides data pertaining to the cancellation of the Event

Calendar Event
calendar_event LegacyCalendarEvent

Information about the calendar event from the calendar provider.

Cancellation

Provides data pertaining to the cancellation of the Event

Name Path Type Description
Canceled By
canceled_by string

Name of the person whom canceled.

Cancellation Reason
reason string

Reason that the cancellation occurred.

Canceler Type
canceler_type string

Indicates whether the event was canceled by the "Host" or "Invitee".

Guest

An individual whom an invitee has invited to be a guest attendee to an event

Name Path Type Description
Event Guest Email
email email

The email of the event guest.

Event Guest Created At
created_at date-time

Time that the event guest was created.

Event Guest Updated At
updated_at date-time

Time that the event guest was last updated.

Location

The polymorphic base type for an event location that Calendly supports

Name Path Type Description
Location Type
type string

Indicates the event location type.

Web Conference Status
status string

This field only applies to zoom_conference, webex_conference, google_conference, gotomeeting, and microsoft_teams_conference location types.

Web Conference Meeting URL
join_url uri

This field only applies to zoom_conference, webex_conference, google_conference, gotomeeting, and microsoft_teams_conference location types.

Event Location
location string

This field only applies to outbound_call, inbound_call, physical, ask_invitee, and custom location types.

LegacyCalendarEvent

Information about the calendar event from the calendar provider.

Name Path Type Description
Calendly Event Kind
kind string

Indicates the calendar provider the event belongs to.

External Calendar Event Id
external_id string

The id provided from the calendar provider for this calendar event.

Payment

Invitee payment

Name Path Type Description
Payment External Id
external_id string

Unique identifier for the payment.

Payment Provider
provider string

Payment provider.

Payment Amount
amount float

The amount of the payment.

Payment Currency
currency string

The currency format that the payment is in.

Payment Terms
terms string

Terms of the payment.

Payment Successful?
successful boolean

Indicates whether the payment was successfully processed.

NoShow

Provides data pertaining to the associated no show for the Invitee.

Name Path Type Description
No Show URI
uri string

Canonical reference (unique identifier) for the no show

No Show Created At
created_at date-time

The moment when the no show was created.

EventType

Name Path Type Description
Event Type URI
uri string

Canonical reference (unique identifier) for the event type.

Event Type Name
name string

The event type name (in human-readable format).

Active
active boolean

Indicates if the event is active or not.

Booking Method
booking_method string

Indicates if the event type is for a poll or an instant booking.

Slug
slug string

The portion of the event type's URL that identifies a specific web page (in a human-readable format).

Scheduling URL
scheduling_url string

The URL of the user’s scheduling site where invitees book this event type.

Duration
duration integer

The length of sessions booked with this event type.

Kind
kind string

Indicates if the event type is "solo" (belongs to an individual user) or "group".

Pooling Type
pooling_type string

Indicates if the event type is "round robin" (alternates between hosts) or "collective" (invitees pick a time when all participants are available) or "null" (the event type doesn’t consider the availability of a group participants).

Type
type string

Indicates if the event type is "AdhocEventType" (ad hoc event) or "StandardEventType" (standard event type).

Color
color string

The hexadecimal color value of the event type's scheduling page.

Created At
created_at string

The moment the event type was created (e.g. "2020-01-02T03:04:05.678123Z").

Updated At
updated_at string

The moment the event type was last updated (e.g. "2020-01-02T03:04:05.678123Z").

Internal Note
internal_note string

Contents of a note that may be associated with the event type.

Description (Plain)
description_plain string

The event type's description (in non formatted text).

Description (HTML)
description_html string

The event type's description (formatted with HTML).

Profile Type
profile.type string

Indicates if the profile belongs to a "user" (individual) or "team".

Profile Name
profile.name string

Human-readable name for the profile of the user that's associated with the event type.

Profile Owner URI
profile.owner string

The unique reference to the user associated with the profile.

Secret
secret boolean

Indicates if the event type is hidden on the owner's main scheduling page.

Deleted At
deleted_at string

The moment the event type was deleted (e.g. "2020-01-02T03:04:05.678123Z").

Admin Managed
admin_managed boolean

Indicates if this event type is managed by an organization admin.

custom_questions
custom_questions array of object

custom_questions

Custom Question Name
custom_questions.name string

name

Custom Question Type
custom_questions.type string

type

Custom Question Position
custom_questions.position integer

position

Custom Question Enabled
custom_questions.enabled boolean

enabled

Custom Question Required
custom_questions.required boolean

required

Custom Question Answer Choices
custom_questions.answer_choices array of string

answer_choices

Include Other
custom_questions.include_other boolean

include_other

Reconfirmation

Assuming reconfirmation is enabled for the event type, when reconfirmation is requested this object is present with a created_at that reflects when the reconfirmation notification was sent. Once the invitee has reconfirmed the confirmed_at attribute will change from null to a timestamp that reflects when they took action.

Name Path Type Description
Reconfirmation Created At
created_at date-time

When the reconfirmation was created.

Invitee Confirmed At
confirmed_at date-time

When the Invitee confirmed their attendance.