Calendly

Learn how to use Calendly with Composio

Overview

Enum

CALENDLY

Description

Calendly is an appointment scheduling tool that automates meeting invitations, availability checks, and reminders, helping individuals and teams avoid email back-and-forth

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
base_url
stringDefaults to https://api.calendly.com

Actions

Permanently cancels an existing, active scheduled event by its `uuid`, optionally providing a `reason`, which may trigger notifications to invitees.

Action Parameters

reason
string
uuid
stringRequired

Action Response

data
object
error
successful
boolean
Marks an invitee, identified by their existing and valid uri, as a 'no show' for a scheduled event.

Action Parameters

invitee
string

Action Response

data
object
error
successful
boolean
Creates a temporary calendly one-off event type for unique meetings outside regular availability, requiring valid host/co-host uris, a future date/range for `date setting`, and a positive `duration`.

Action Parameters

date_setting
objectRequired
duration
integerRequired
host
stringRequired
location
object
name
stringRequired
only_weekdays
boolean
timezone
stringDefaults to UTC

Action Response

data
object
error
successful
boolean
Creates a customizable, one-time share link for a calendly event type, allowing specific overrides to its settings (e.g., duration, availability, location) without altering the original event type.

Action Parameters

availability__rule__rules
array
availability__rule__timezone
string
duration
integer
duration_options
array
end_date
string
event_type
stringRequired
hide_location
boolean
location_configurations
array
max_booking_time
integer
name
string
period_type
string
start_date
string

Action Response

data
object
error
successful
boolean
Creates a calendly webhook subscription to notify a specified `url` (which must be a publicly accessible https endpoint) for selected `events` within a given `organization` and `scope`.

Action Parameters

events
arrayRequired
group
string
organization
stringRequired
scope
stringRequired
signing_key
string
url
stringRequired
user
string

Action Response

data
object
error
successful
boolean
Permanently removes all invitee data associated with the provided emails from past organization events, for data privacy compliance (requires enterprise subscription; deletion may take up to one week).

Action Parameters

emails
arrayRequired

Action Response

data
object
error
successful
boolean
Deletes an invitee no-show record by its `uuid` to reverse an invitee's 'no-show' status; the `uuid` must refer to an existing record.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
For enterprise users, initiates deletion of an organization's scheduled event data between a `start time` and `end time` (inclusive, where `start time` must be <= `end time`); actual data deletion may take up to 7 days to complete.

Action Parameters

end_time
stringRequired
start_time
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing webhook subscription to stop calendly sending event notifications to its registered callback url; this operation is idempotent.

Action Parameters

webhook_uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about the currently authenticated calendly user.

Action Parameters

Action Response

data
object
error
successful
boolean
Use to retrieve a specific calendly scheduled event by its uuid, provided the event exists in the user's calendly account.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific invitee of a scheduled event, using their unique uuids.

Action Parameters

event_uuid
stringRequired
invitee_uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves details for a specific calendly event type, identified by its uuid, which must be valid and correspond to an existing event type.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all attributes of a specific calendly group by its uuid; the group must exist.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific calendly group relationship by its valid and existing uuid, providing details on user-group associations and membership.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves details for a specific invitee no show record by its uuid; an invitee no show is marked when an invitee does not attend a scheduled event.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific calendly organization invitation using its uuid and the parent organization's uuid.

Action Parameters

org_uuid
stringRequired
uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific calendly organization membership by its uuid, returning all its attributes.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific routing form by its uuid, providing its configuration details including questions and routing logic.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves comprehensive details for an existing calendly user.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves an existing user availability schedule by its uuid; this schedule defines the user's default hours of availability.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the details of an existing webhook subscription, identified by its uuid, including its callback url, subscribed events, scope, and state.

Action Parameters

webhook_uuid
stringRequired

Action Response

data
object
error
successful
boolean
Invites a user to the specified calendly organization by email, if they aren't already a member and lack a pending invitation to it.

Action Parameters

email
stringRequired
uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of activity log entries for a specified calendly organization (requires an active enterprise subscription), supporting filtering, sorting, and pagination.

Action Parameters

action
array
actor
array
count
integerDefaults to 20
max_occurred_at
string
min_occurred_at
string
namespace
array
organization
stringRequired
page_token
string
search_term
string
sort
arrayDefaults to ['occurred_at:desc']

Action Response

data
object
error
successful
boolean
Retrieves a list of scheduled calendly events; requires `user`, `organization`, `group`, or `invitee email` for scope, and admin rights may be needed when filtering by `organization` or `group`.

Action Parameters

count
integerDefaults to 20
group
string
invitee_email
string
max_start_time
string
min_start_time
string
organization
string
page_token
string
sort
string
status
string
user
string

Action Response

data
object
error
successful
boolean
Retrieves a list of invitees for a specified calendly event uuid, with options to filter by status or email, and sort by creation time.

Action Parameters

count
integerDefaults to 20
email
string
page_token
string
sort
stringDefaults to created_at:asc
status
string
uuid
stringRequired

Action Response

data
object
error
successful
boolean
Fetches available time slots for a calendly event type within a specified time range; results are not paginated.

Action Parameters

end_time
stringRequired
event_type
stringRequired
start_time
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of hosts (users) assigned to a specific, existing calendly event type, identified by its uri.

Action Parameters

count
integerDefaults to 20
event_type
stringRequired
page_token
string

Action Response

data
object
error
successful
boolean
Returns a list of groups for a specified calendly organization uri, supporting pagination.

Action Parameters

count
integerDefaults to 20
organization
stringRequired
page_token
string

Action Response

data
object
error
successful
boolean
Retrieves a list of group relationships defining an owner's role (e.g., member, admin) within a group; an owner can have one membership per group but multiple admin roles across different groups.

Action Parameters

count
integerDefaults to 20
group
string
organization
string
owner
string
page_token
string

Action Response

data
object
error
successful
boolean
Retrieves a list of invitations for a specific organization, identified by its uuid.

Action Parameters

count
integerDefaults to 20
email
string
page_token
string
sort
stringDefaults to created_at:asc
status
string
uuid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of organization memberships.

Action Parameters

count
integerDefaults to 20
email
string
organization
string
page_token
string
user
string

Action Response

data
object
error
successful
boolean
Retrieves a list of outgoing sms communications for a specified organization; requires an enterprise subscription and if filtering by creation date, both `min created at` and `max created at` must be provided to form a valid range.

Action Parameters

count
integerDefaults to 20
max_created_at
string
min_created_at
string
organization
stringRequired
page_token
string

Action Response

data
object
error
successful
boolean
Retrieves routing forms for a specified organization; routing forms are questionnaires used to direct invitees to appropriate booking pages or external urls.

Action Parameters

count
integerDefaults to 20
organization
stringRequired
page_token
string
sort
string

Action Response

data
object
error
successful
boolean
Retrieves all availability schedules for the specified calendly user.

Action Parameters

user
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a user's busy time intervals (internal and external calendar events) in ascending order for a period up to 7 days; keyset pagination is not supported.

Action Parameters

end_time
stringRequired
start_time
stringRequired
user
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves event types for a user or organization; requires either the `user` or `organization` uri.

Action Parameters

active
boolean
admin_managed
boolean
count
integerDefaults to 20
organization
string
page_token
string
sort
stringDefaults to name:asc
user
string
user_availability_schedule
string

Action Response

data
object
error
successful
boolean
Retrieves webhook subscriptions for a calendly organization; `scope` determines if `user` or `group` uri is also required for filtering.

Action Parameters

count
integerDefaults to 20
group
string
organization
stringRequired
page_token
string
scope
stringRequired
sort
string
user
string

Action Response

data
object
error
successful
boolean
Removes a user (who is not an owner) from an organization by their membership uuid, requiring administrative privileges.

Action Parameters

uuid
stringRequired

Action Response

data
object
error
successful
boolean
Revokes a pending and revokable (not yet accepted or expired) organization invitation using its uuid and the organization's uuid, rendering the invitation link invalid.

Action Parameters

org_uuid
stringRequired
uuid
stringRequired

Action Response

data
object
error
successful
boolean