Skip to main content

Calendly Component

Calendly is an industry leading scheduling solution for businesses. Use the Calendly component to manage the scheduling of events; attendee availability; and retrieve pertinent data on users and attendees.

Component key: calendly

Changelog ↓

Description​

Calendly is an industry leading scheduling solution for businesses.

The Calendly component allows managing the scheduling of events, attendee availability, and retrieving pertinent data on users and attendees.

API Documentation​

This component was built using the Calendly API Documentation

Connections​

OAuth 2.0​

key: calendlyOauth2Connection

A Calendly Developer Account is required to create applications for OAuth. Refer to the following guide for more information.

Prerequisites​

  • A Calendly Developer Account

Setup Steps​

  1. Log in to the Calendly Developer Account and navigate to the Apps Portal
  2. Follow the steps and enter the following information:
    1. Kind of app - Web
    2. Environment type - Production or Sandbox. Separate apps will be needed for each environment.
    3. Redirect URI - https://oauth2.prismatic.io/callback
  3. Continue and copy the Client ID, Client Secret, and Webhook signing key

Configure the Connection​

Create a connection of type OAuth 2.0 and enter:

  • Authorize URL: The OAuth 2.0 Authorization URL (default: https://auth.calendly.com/oauth/authorize)
  • Token URL: The OAuth 2.0 Token URL (default: https://auth.calendly.com/oauth/token)
  • Scopes: Set the desired scopes (default: default)
  • Client ID: Enter the Client ID from the Calendly application
  • Client Secret: Enter the Client Secret from the Calendly application
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for the Calendly API.

https://auth.calendly.com/oauth/authorize
Client ID

The Client ID from the OAuth application credentials.

Client Secret

The Client Secret from the OAuth application credentials.

Scopes

Space-separated list of OAuth permission scopes.

default
Token URL

The OAuth 2.0 Token URL for the Calendly API.

https://auth.calendly.com/oauth/token
Use Live Server

When true, uses the live server. When false, uses the mock server.

false

Triggers​

Scheduled Event​

Receive data from scheduled events in real time with webhook subscriptions. | key: calendlyTrigger

InputNotesExample
Connection

The Calendly connection to use.

Webhook Event Name

The webhook event types to subscribe to.

Organization

The unique reference to the organization that the webhook will be tied to.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Scope

Indicates if the webhook subscription scope will be 'organization' or 'user'.

Signing Key

Optional secret key shared between your application and Calendly. See https://developer.calendly.com/api-docs/ZG9jOjM2MzE2MDM4-webhook-signatures for additional information.

User

The unique reference to the user that the webhook will be tied to.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

The Scheduled Event trigger receives data from Calendly in real time through automatically managed webhook subscriptions. Unlike manual webhook setups, the entire webhook lifecycle is handled automatically.

How It Works​

When this trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a webhook subscription in Calendly pointing to the instance's unique webhook URL. If a webhook with the same URL already exists, it reuses the existing subscription to prevent duplication.
  • On Instance Deletion: The trigger automatically removes the webhook subscription from Calendly, cleaning up all webhooks that point to the instance's flow endpoint.

Configuration​

Configure the following inputs:

  • Connection: The Calendly OAuth 2.0 connection to authenticate API requests.
  • Organization: The unique reference to the organization that the webhook will be tied to. This is required.
  • User: The unique reference to the user that the webhook will be tied to. Only required when Scope is set to "User".
  • Webhook Event Name: The event types to subscribe to. Select one or more from the available events below.
  • Scope: Determines whether the webhook subscription applies at the "Organization" or "User" level.
  • Signing Key: Optional secret key shared between the application and Calendly for webhook signature verification.

Event Types​

Available Events (4)
EventDescription
invitee.createdFires when an invitee schedules an event
invitee.canceledFires when an invitee cancels a scheduled event
invitee_no_show.createdFires when an invitee is marked as a no-show
routing_form_submission.createdFires when a routing form submission is created

Refer to Calendly's webhook documentation for the complete and up-to-date list of events.

Returned Data​

The trigger returns the webhook payload received from Calendly.

Example Payload
{
  "event": "invitee.created",
  "time": "2020-11-23T17:51:18.327602Z",
  "payload": {
    "event_type": {
      "uuid": "AAAAAAAAAAAAAAAA",
      "kind": "solo",
      "slug": "15-minute-meeting",
      "name": "15 Minute Meeting",
      "duration": 15,
      "owner": {
        "type": "users",
        "uuid": "BBBBBBBBBBBBBBBB"
      }
    },
    "event": {
      "uuid": "CCCCCCCCCCCCCCCC",
      "assigned_to": ["Jane Doe"],
      "extended_assigned_to": [
        {
          "name": "Jane Doe",
          "email": "user@example.com",
          "primary": true
        }
      ],
      "start_time": "2020-11-25T15:30:00.000000Z",
      "start_time_pretty": "03:30pm - Wednesday, November 25, 2020",
      "invitee_start_time": "2020-11-25T15:30:00.000000Z",
      "invitee_start_time_pretty": "03:30pm - Wednesday, November 25, 2020",
      "end_time": "2020-11-25T15:45:00.000000Z",
      "end_time_pretty": "03:45pm - Wednesday, November 25, 2020",
      "invitee_end_time": "2020-11-25T15:45:00.000000Z",
      "invitee_end_time_pretty": "03:45pm - Wednesday, November 25, 2020",
      "created_at": "2020-11-23T17:51:18.327602Z",
      "location": "Zoom",
      "canceled": false,
      "canceler_name": null,
      "cancel_reason": null,
      "canceled_at": null
    },
    "invitee": {
      "uuid": "DDDDDDDDDDDDDDDD",
      "first_name": "John",
      "last_name": "Doe",
      "name": "John Doe",
      "email": "test@example.com",
      "text_reminder_number": null,
      "timezone": "America/New_York",
      "created_at": "2020-11-23T17:51:18.327602Z",
      "is_reschedule": false,
      "payments": [],
      "canceled": false,
      "canceler_name": null,
      "cancel_reason": null,
      "canceled_at": null
    },
    "questions_and_answers": [
      {
        "question": "Question with Radio Buttons answer type",
        "answer": "radio button answer",
        "position": 0
      }
    ],
    "questions_and_responses": {
      "1_question": "Question with Radio Buttons answer type",
      "1_response": "radio button answer"
    },
    "tracking": {
      "utm_campaign": null,
      "utm_source": null,
      "utm_medium": null,
      "utm_content": null,
      "utm_term": null,
      "salesforce_uuid": null
    },
    "old_event": null,
    "old_invitee": null,
    "new_event": null,
    "new_invitee": null
  }
}

Notes​

  • When an invitee reschedules an event, both invitee.created and invitee.canceled events fire. The canceled event payload includes a rescheduled key set to true.
  • Webhook subscriptions require a paid Calendly premium subscription or above.
  • The Signing Key input enables webhook payload signature verification for added security.

Data Sources​

Select Event​

Select an Event. | key: events | type: picklist

InputNotesExample
Connection

The Calendly connection to use.

Invitee Email

Return events scheduled with the invitee associated with this email address.

alice@example.com
Max Start Time

Include events with start times prior to this time. Format: ISO 8601 datetime.

2020-01-02T12:30:00.000000Z
Min Start Time

Include events with start times after this time. Format: ISO 8601 datetime.

2020-01-02T12:30:00.000000Z
Organization

Return events scheduled with the organization associated with this URI.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Return UUID Only

When enabled, returns only the UUID from the URI instead of the full URI.

false
Sort

Order results by the created_at field and direction specified: ascending ('asc') or descending ('desc').

Status

Indicates if the invitee 'canceled' or still 'active'.

active
User

Return events scheduled with the user associated with this URI.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

Select Event Invitee​

Select an Event Invitee. | key: selectEventInvitee | type: picklist

InputNotesExample
Connection

The Calendly connection to use.

Return UUID Only

When enabled, returns only the UUID from the URI instead of the full URI.

false
UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

Select Event Type​

Select an Event Type associated with a specified User. Either organization or user are required. | key: eventTypes | type: picklist

InputNotesExample
Active

When true, returns only active event types. When false, returns only inactive event types.

false
Admin Managed

When true, returns only admin managed event types. When false, excludes admin managed event types.

false
Connection

The Calendly connection to use.

Organization

View available personal, team, and organization event types associated with the organization's URI.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Return UUID Only

When enabled, returns only the UUID from the URI instead of the full URI.

false
Sort

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: name. Sort direction is specified as: asc, desc.

name:asc
User

View available personal, team, and organization event types associated with the user's URI.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ
User Availability Schedule

Used in conjunction with user parameter, returns a filtered list of Event Types that use the given primary availability schedule.

Select Organization Membership​

Select an Organization Membership. | key: organizationMemberships | type: picklist

InputNotesExample
Connection

The Calendly connection to use.

Email

Indicates if the results should be filtered by email address

user@example.com
Organization

Indicates if the results should be filtered by organization

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Return UUID Only

When enabled, returns only the UUID from the URI instead of the full URI.

false
User

Indicates if the results should be filtered by user

https://api.calendly.com/users/UR1234567890

Select Routing Form​

Select a Routing Form from a specified Organization. | key: routingForms | type: picklist

InputNotesExample
Connection

The Calendly connection to use.

Organization

View organization routing forms associated with the organization's URI.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Return UUID Only

When enabled, returns only the UUID from the URI instead of the full URI.

false
Sort

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.

created_at:desc

Actions​

Cancel Event​

Cancels specified event. | key: cancelEvent

InputNotesExample
Connection

The Calendly connection to use.

Reason

The reason for canceling the event.

UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "canceled_by": "string",
      "reason": "string",
      "canceler_type": "host",
      "created_at": "2019-01-02T03:04:05.678123Z"
    }
  }
}

Create Share​

Allows you to create an endpoint for the Customize Once and Share feature. | key: createShare

InputNotesExample
Availability Rule

Availability rules defining when the event type can be scheduled.

Connection

The Calendly connection to use.

Duration

The duration of the event in minutes.

60
End Date

Required when period_type is 'fixed'. Format: YYYY-MM-DD.

2019-01-03
Event Type

The URI associated with the event type.

Hide Location

When true, the location is hidden until the invitee books a spot. Only respected when there is a single custom location configured.

false
Location Configurations

Array of location configurations for the event type.

Max Booking Time

Required when period_type is 'moving' or 'available_moving'.

300
Name

The name of the resource.

15 Minute Meeting
Period Type

The type of scheduling period for the event type.

Start Date

Required when period_type is 'fixed'. Format: YYYY-MM-DD.

2019-01-02

{
  "data": {
    "resource": {
      "scheduling_links": [
        {
          "booking_url": "https://calendly.com/d/abcd-brv8/15-minute-meeting",
          "owner": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
          "owner_type": "EventType"
        }
      ],
      "share_override": {
        "name": "15 Minute Meeting",
        "duration": 60,
        "period_type": "fixed",
        "start_date": "2019-01-02",
        "end_date": "2019-01-03",
        "max_booking_time": 300,
        "hide_location": true,
        "location_configurations": [
          {
            "location": "123 Abc St.",
            "additional_info": "Example additional info",
            "phone_number": "+1 888-888-8888",
            "position": 0,
            "kind": "physical"
          }
        ],
        "availability_rule": {
          "rules": [
            {
              "type": "wday",
              "wday": "friday",
              "date": "2019-01-02",
              "intervals": [
                {
                  "from": "07:00",
                  "to": "11:00"
                }
              ]
            }
          ],
          "timezone": "America/New_York"
        }
      }
    }
  }
}

Creates a single-use scheduling link. | key: createSingleUseSchedulingLink

InputNotesExample
Connection

The Calendly connection to use.

Max Event Count

The max number of events that can be scheduled using this scheduling link.

1
Owner

A link to the resource that owns this Scheduling Link (currently, this is always an Event Type).

https://api.calendly.com/event_types/012345678901234567890
Owner Type

Resource type (currently, this is always EventType).

EventType

{
  "data": {
    "resource": {
      "booking_url": "https://calendly.com/d/abcd-brv8/15-minute-meeting",
      "owner": "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2",
      "owner_type": "EventType"
    }
  }
}

Create Webhook Subscription​

Create a Webhook Subscription for an Organization or User. | key: createWebhookSubscription

InputNotesExample
Connection

The Calendly connection to use.

Event

Event to subscribe to.

invitee.canceled, invitee.created, invitee_no_show.created, routing_form_submission.created
Organization

The unique reference to the organization that the webhook will be tied to.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Scope

Indicates if the webhook subscription scope will be 'organization' or 'user'.

Signing Key

Optional secret key shared between your application and Calendly. See https://developer.calendly.com/api-docs/ZG9jOjM2MzE2MDM4-webhook-signatures for additional information.

URL

The URL where you want to receive POST requests for events you are subscribed to.

User

The unique reference to the user that the webhook will be tied to.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA",
      "callback_url": "https://blah.foo/bar",
      "created_at": "2019-08-24T14:15:22.123456Z",
      "updated_at": "2019-08-24T14:15:22.123456Z",
      "retry_started_at": "2019-08-24T14:15:22.123456Z",
      "state": "active",
      "events": [
        "invitee.created"
      ],
      "scope": "user",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "creator": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
    }
  }
}

Delete Instanced Webhooks​

Delete all webhooks that point to a flow in this instance. | key: deleteInstancedWebhooks

InputNotesExample
Connection

The Calendly connection to use.

Organization

Organization to delete webhooks from

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Scope

Organization or user webhooks to delete

User

User to delete webhooks from. Required if scope is set to user.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

Delete Invitee Data​

To submit a request to remove invitee data from all previously booked events in your organization, use this endpoint. | key: deleteInviteeData

InputNotesExample
Connection

The Calendly connection to use.

Email

Invitee email to delete.

{
  "data": {}
}

Delete Scheduled Event Data​

To submit a request to remove scheduled events data within a time range for your organization, use this endpoint. | key: deleteScheduledEventData

InputNotesExample
Connection

The Calendly connection to use.

End Time

The scheduled events UTC timestamp at which data deletion should end. Format: ISO 8601 datetime.

2021-01-01T02:04:05.678123Z
Start Time

The scheduled events UTC timestamp at which data deletion should begin. Format: ISO 8601 datetime.

2019-01-02T03:04:05.678123Z

{
  "data": {}
}

Delete Webhook Subscription​

Delete a Webhook Subscription. | key: deleteWebhookSubscription

InputNotesExample
Connection

The Calendly connection to use.

Webhook UUID

The webhook's unique identifier.

Get Current User​

Returns basic information about your user account. | key: getCurrentUser

InputNotesExample
Connection

The Calendly connection to use.

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "name": "John Doe",
      "slug": "acmesales",
      "email": "user@example.com",
      "scheduling_url": "https://calendly.com/acmesales",
      "timezone": "America/New York",
      "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "current_organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "resource_type": "User"
    }
  }
}

Get Event​

Returns information about a specified Event. | key: getEvent

InputNotesExample
Connection

The Calendly connection to use.

UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2",
      "name": "15 Minute Meeting",
      "status": "active",
      "booking_method": "instant",
      "start_time": "2019-08-24T14:15:22.000000Z",
      "end_time": "2019-08-24T14:15:22.000000Z",
      "event_type": "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2",
      "location": {
        "type": "physical",
        "location": "Calendly Office"
      },
      "invitees_counter": {
        "total": 0,
        "active": 0,
        "limit": 0
      },
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-01-02T03:04:05.678123Z",
      "event_memberships": [
        {
          "user": "https://api.calendly.com/users/GBGBDCAADAEDCRZ2",
          "user_email": "user@example.com"
        }
      ],
      "event_guests": [
        {
          "email": "user@example.com",
          "created_at": "2019-08-24T14:15:22.123456Z",
          "updated_at": "2019-08-24T14:15:22.123456Z"
        }
      ],
      "calendar_event": {
        "kind": "google",
        "external_id": "8suu9k3hj00mni03ss12ba0ce0"
      }
    }
  }
}

Get Event Invitee​

Returns information about a specified Invitee (person invited to an event). | key: getEventInvitee

InputNotesExample
Connection

The Calendly connection to use.

Event UUID

The event's unique identifier.

Invitee UUID

The invitee's unique identifier.

{
  "data": {
    "resource": {
      "cancel_url": "https://calendly.com/cancellations/AAAAAAAAAAAAAAAA",
      "created_at": "2022-04-21T17:11:43.092010Z",
      "email": "email@example.com",
      "rescheduled": false,
      "reschedule_url": "https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA",
      "event": "https://api.calendly.com/scheduled_events/ABCDABCDABCDABCD",
      "name": "John Doe",
      "first_name": null,
      "last_name": null,
      "new_invitee": null,
      "old_invitee": null,
      "status": "active",
      "text_reminder_number": null,
      "timezone": "America/New_York",
      "tracking": {
        "utm_campaign": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_content": null,
        "utm_term": null,
        "salesforce_uuid": null
      },
      "updated_at": "2020-01-01T20:30:00.000000Z",
      "uri": "https://api.calendly.com/api/v2/scheduled_events/ABCDABCDABCDABCD/invitees/ABCDABCDABCDABCD",
      "questions_and_answers": [
        {
          "answer": "radio button answer",
          "position": 0,
          "question": "Question with Radio Buttons answer type"
        },
        {
          "answer": "Multiple line\nAnswer",
          "position": 1,
          "question": "Question with Multiple Lines answer type"
        },
        {
          "answer": "Answer 1\nAnswer 2\nAnswer 3",
          "position": 2,
          "question": "Question with Checkboxes answer type"
        }
      ],
      "routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
      "payment": {
        "external_id": "ch_AAAAAAAAAAAAAAAAAAAAAAAA",
        "provider": "stripe",
        "amount": 1234.56,
        "currency": "USD",
        "terms": "sample terms of payment (up to 1,024 characters)",
        "successful": true
      },
      "no_show": null,
      "reconfirmation": {
        "created_at": "2020-11-23T17:51:18.341657Z",
        "confirmed_at": "2020-11-23T20:01:18.341657Z"
      },
      "scheduling_method": null,
      "invitee_scheduled_by": null
    }
  }
}

Get Event Type​

Returns information about a specified Event Type. | key: getEventType

InputNotesExample
Connection

The Calendly connection to use.

UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
      "name": "15 Minute Meeting",
      "active": true,
      "booking_method": "instant",
      "slug": "acmesales",
      "scheduling_url": "https://calendly.com/acmesales",
      "duration": 30,
      "kind": "solo",
      "pooling_type": "round_robin",
      "type": "StandardEventType",
      "color": "#fff200",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "internal_note": "Internal note",
      "description_plain": "15 Minute Meeting",
      "description_html": "<p>15 Minute Meeting</p>",
      "profile": {
        "type": "User",
        "name": "Tamara Jones",
        "owner": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
      },
      "secret": true,
      "deleted_at": null,
      "admin_managed": false,
      "custom_questions": [
        {
          "name": "Company Name",
          "type": "string",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        },
        {
          "name": "What would you like to discuss?",
          "type": "text",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        },
        {
          "name": "Number of employees",
          "answer_choices": [
            "1",
            "2-10",
            "11-20",
            "20+"
          ],
          "enabled": true,
          "include_other": true,
          "position": 2,
          "required": false,
          "type": "single_select"
        },
        {
          "name": "Multi-Select Question",
          "answer_choices": [
            "Answer 1",
            "Answer 2",
            "Answer 3",
            "Answer 4"
          ],
          "enabled": true,
          "include_other": true,
          "position": 2,
          "required": false,
          "type": "multi_select"
        },
        {
          "name": "Phone Number",
          "type": "phone_number",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        }
      ]
    }
  }
}

Get Organization Invitation​

Returns an Organization Invitation that was sent to the organization's members. | key: getOrganizationInvitation

InputNotesExample
Connection

The Calendly connection to use.

Organization UUID

The organization's unique identifier.

UUID

The organization invitation's unique identifier.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "email": "test@example.com",
      "status": "accepted",
      "created_at": "2019-08-07T06:05:04.321123Z",
      "updated_at": "2019-01-02T03:04:05.678123Z",
      "last_sent_at": "2019-01-02T03:04:05.678123Z",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
    }
  }
}

Get Organization Membership​

Returns information about a user's Organization Membership. | key: getOrganizationMembership

InputNotesExample
Connection

The Calendly connection to use.

UUID

The organization membership's unique identifier.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA",
      "role": "admin",
      "user": {
        "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
        "name": "John Doe",
        "slug": "acmesales",
        "email": "test@example.com",
        "scheduling_url": "https://calendly.com/acmesales",
        "timezone": "America/New York",
        "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
        "created_at": "2019-01-02T03:04:05.678123Z",
        "updated_at": "2019-08-07T06:05:04.321123Z"
      },
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "created_at": "2019-01-02T03:04:05.678123Z"
    }
  }
}

Get Routing Form​

Get a specified Routing Form. | key: getRoutingForm

InputNotesExample
Connection

The Calendly connection to use.

UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "name": "ACME Demo",
      "status": "published",
      "questions": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "What is your industry?",
          "type": "select",
          "required": true,
          "answer_choices": [
            "IT & Software",
            "Financial Services",
            "Entertainment"
          ]
        },
        {
          "uuid": "1213f8f1-57fd-45ee-88e9-1978d35b5cad",
          "name": "Email",
          "type": "email",
          "required": true,
          "answer_choices": null
        }
      ],
      "created_at": "2022-05-15T03:04:05.678Z",
      "updated_at": "2022-05-15T06:05:04.321Z"
    }
  }
}

Get Routing Form Submission​

Get a specified Routing Form Submission. | key: getRoutingFormSubmission

InputNotesExample
Connection

The Calendly connection to use.

UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
      "routing_form": "https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA",
      "questions_and_answers": [
        {
          "question_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "question": "What is your industry?",
          "answer": "IT & Software"
        }
      ],
      "tracking": {
        "utm_campaign": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_content": null,
        "utm_term": null,
        "salesforce_uuid": null
      },
      "result": {
        "type": "event_type",
        "value": "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2"
      },
      "submitter": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA",
      "submitter_type": "Invitee",
      "created_at": "2022-05-15T03:04:05.678Z",
      "updated_at": "2022-05-15T06:05:04.321Z"
    }
  }
}

Get User​

Returns information about a specified User. | key: getUser

InputNotesExample
Connection

The Calendly connection to use.

UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "name": "John Doe",
      "slug": "acmesales",
      "email": "test@example.com",
      "scheduling_url": "https://calendly.com/acmesales",
      "timezone": "America/New York",
      "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "current_organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "resource_type": "User"
    }
  }
}

Get User Availability Schedule​

This will return the availability schedule of the given UUID. | key: getUserAvailabilitySchedule

InputNotesExample
Connection

The Calendly connection to use.

UUID

The UUID of the availability schedule.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/user_availability_schedule/abc123",
      "default": true,
      "name": "Working Hours",
      "user": "https://api.calendly.com/users/abc123",
      "timezone": "America/New_York",
      "rules": [
        {
          "type": "wday",
          "intervals": [
            {
              "from": "08:30",
              "to": "09:30"
            }
          ],
          "wday": "sunday",
          "date": "2022-12-31"
        }
      ]
    }
  }
}

Get Webhook Subscription​

Get a specified Webhook Subscription. | key: getWebhookSubscription

InputNotesExample
Connection

The Calendly connection to use.

Webhook UUID

The webhook's unique identifier.

{
  "data": {
    "resource": {
      "uri": "https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA",
      "callback_url": "https://blah.foo/bar",
      "created_at": "2019-08-24T14:15:22.123456Z",
      "updated_at": "2019-08-24T14:15:22.123456Z",
      "retry_started_at": "2019-08-24T14:15:22.123456Z",
      "state": "active",
      "events": [
        "invitee.created"
      ],
      "scope": "user",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "creator": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
    }
  }
}

Invite User to Organization​

Invites a user to an organization. | key: inviteUserToOrganization

InputNotesExample
Connection

The Calendly connection to use.

Email

The email address of the user to invite.

bob@example.com
UUID

The UUID of the organization.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": {
    "resource": {
      "created_at": "2020-01-01T20:30:00.000000Z",
      "email": "email@example.com",
      "last_sent_at": "2020-01-01T20:30:00.123456Z",
      "organization": "https://api.calendly.com/organizations/ABCDABCDABCDABCD",
      "status": "pending",
      "updated_at": "2020-01-01T20:30:00.000000Z",
      "uri": "https://api.calendly.com/organizations/ABCDABCDABCDABCD/invitations/DCBADCBADCBADCBA"
    }
  }
}

List Activity Log Entries​

Returns a list of activity log entries. | key: listActivityLogEntries

InputNotesExample
Action

The action associated with the entries.

Actor

Return entries from the user associated with the provided URI.

Connection

The Calendly connection to use.

Max Occurred At

Include entries that occurred prior to this time. This time should use the UTC timezone. Format: ISO 8601 datetime.

2020-01-02T03:04:05.678Z
Min Occurred At

Include entries that occurred after this time. This time should use the UTC timezone. Format: ISO 8601 datetime.

2020-01-02T03:04:05.678Z
Namespace

The category of the entry.

Organization

Return activity log entries from the organization associated with this URI

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Search Term

Filters entries based on the search term.

compliance
Sort

Order results by the specified field and direction. {field}:{direction} value.

{
  "data": [
    {
      "occurred_at": "2020-01-02T03:04:05.678Z",
      "uri": "https://api.calendly.com/activity_log_entries/ALFKJELNCLKSJDLKFJGELKJ",
      "namespace": "User",
      "action": "Add",
      "actor": {
        "uri": "https://api.calendly.com/users/SDLKJENFJKD123",
        "type": "User",
        "organization": {
          "uri": "https://api.calendly.com/organizations/LKJENFLKE293847",
          "role": "Owner"
        },
        "group": {
          "uri": "https://api.calendly.com/groups/123987DJLKJEF",
          "name": "Development",
          "role": "Admin"
        },
        "display_name": "Test User",
        "alternative_identifier": "testuser@example.com"
      },
      "fully_qualified_name": "User.Add",
      "details": {},
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAA"
    }
  ]
}

List Event Invitees​

Returns a list of Invitees for an event. | key: listEventInvitees

InputNotesExample
Connection

The Calendly connection to use.

Email

Indicates if the results should be filtered by email address.

bob@example.com
Sort

Order results by the created_at field and direction specified: ascending ('asc') or descending ('desc').

Status

Indicates if the invitee 'canceled' or still 'active'.

active
UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": [
    {
      "cancel_url": "https://calendly.com/cancellations/AAAAAAAAAAAAAAAA",
      "created_at": "2020-11-23T17:51:18.327602Z",
      "email": "test@example.com",
      "event": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "new_invitee": null,
      "old_invitee": null,
      "questions_and_answers": [
        {
          "answer": "radio button answer",
          "position": 0,
          "question": "Question with Radio Buttons answer type"
        },
        {
          "answer": "Multiple line\nAnswer",
          "position": 1,
          "question": "Question with Multiple Lines answer type"
        },
        {
          "answer": "Answer 1\nAnswer 2\nAnswer 3",
          "position": 2,
          "question": "Question with Checkboxes answer type"
        }
      ],
      "reschedule_url": "https://calendly.com/reschedulings/AAAAAAAAAAAAAAAA",
      "rescheduled": false,
      "status": "active",
      "text_reminder_number": null,
      "timezone": "America/New_York",
      "tracking": {
        "utm_campaign": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_content": null,
        "utm_term": null,
        "salesforce_uuid": null
      },
      "updated_at": "2020-11-23T17:51:18.341657Z",
      "uri": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA",
      "routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
      "payment": {
        "external_id": "ch_AAAAAAAAAAAAAAAAAAAAAAAA",
        "provider": "stripe",
        "amount": 1234.56,
        "currency": "USD",
        "terms": "sample terms of payment (up to 1,024 characters)",
        "successful": true
      },
      "no_show": null,
      "reconfirmation": {
        "created_at": "2020-11-23T17:51:18.341657Z",
        "confirmed_at": "2020-11-23T20:01:18.341657Z"
      },
      "scheduling_method": null,
      "invitee_scheduled_by": null
    }
  ]
}

List Event Type Available Times​

Returns a list of available times for an event type within a specified date range. | key: listEventTypeAvailableTimes

InputNotesExample
Connection

The Calendly connection to use.

End Time

End time of the requested availability range.

2021-01-01T02:04:05.678123Z
Event Type

The URI associated with the event type.

Start Time

Start time of the requested availability range.

2019-01-02T03:04:05.678123Z

{
  "data": {
    "collection": [
      {
        "status": "available",
        "invitees_remaining": 2,
        "start_time": "2020-01-02T20:00:00.000000Z",
        "scheduling_url": "https://calendly.com/acmesales/discovery-call/2020-01-02T20:00:00Z?month=2020-01&date=2020-01-02"
      },
      {
        "status": "available",
        "invitees_remaining": 1,
        "start_time": "2020-01-03T15:00:00.000000Z",
        "scheduling_url": "https://calendly.com/acmesales/discovery-call/2020-01-03T15:00:00Z?month=2020-01&date=2020-01-03"
      },
      {
        "status": "available",
        "invitees_remaining": 3,
        "start_time": "2020-01-07T23:00:00.000000Z",
        "scheduling_url": "https://calendly.com/acmesales/discovery-call/2020-01-07T23:00:00Z?month=2020-01&date=2020-01-07"
      }
    ]
  }
}

List Events​

Returns a list of Events. | key: listEvents

InputNotesExample
Connection

The Calendly connection to use.

Invitee Email

Return events scheduled with the invitee associated with this email address.

alice@example.com
Max Start Time

Include events with start times prior to this time. Format: ISO 8601 datetime.

2020-01-02T12:30:00.000000Z
Min Start Time

Include events with start times after this time. Format: ISO 8601 datetime.

2020-01-02T12:30:00.000000Z
Organization

Return events scheduled with the organization associated with this URI.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Sort

Order results by the created_at field and direction specified: ascending ('asc') or descending ('desc').

Status

Indicates if the invitee 'canceled' or still 'active'.

active
User

Return events scheduled with the user associated with this URI.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

{
  "data": [
    {
      "uri": "https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2",
      "name": "15 Minute Meeting",
      "status": "active",
      "start_time": "2019-08-24T14:15:22.123456Z",
      "end_time": "2019-08-24T14:15:22.123456Z",
      "event_type": "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2",
      "location": {
        "type": "physical",
        "location": "Calendly Office"
      },
      "invitees_counter": {
        "total": 0,
        "active": 0,
        "limit": 0
      },
      "created_at": "2019-01-02T03:04:05.092125Z",
      "updated_at": "2019-01-02T03:04:05.092125Z",
      "event_memberships": [
        {
          "user": "https://api.calendly.com/users/GBGBDCAADAEDCRZ2",
          "user_email": "user@example.com"
        }
      ],
      "event_guests": [
        {
          "email": "user@example.com",
          "created_at": "2022-04-21T17:10:48.484945Z",
          "updated_at": "2022-04-21T17:11:01.758636Z"
        }
      ],
      "calendar_event": {
        "kind": "google",
        "external_id": "8suu9k3hj00mni03ss12ba0ce0"
      }
    }
  ]
}

List Organization Invitations​

Returns a list of Organization Invitations that were sent to the organization's members. | key: listOrganizationInvitations

InputNotesExample
Connection

The Calendly connection to use.

Email

Indicates if the results should be filtered by email address

bob@example.com
Sort

Order results by the created_at field and direction specified: ascending ('asc') or descending ('desc').

Status

Indicates if the results should be filtered by status ("pending", "accepted", or "declined")

active
UUID

The unique identifier in UUID format.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

{
  "data": [
    {
      "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "email": "test@example.com",
      "status": "accepted",
      "created_at": "2019-08-07T06:05:04.321123Z",
      "updated_at": "2019-01-02T03:04:05.678123Z",
      "last_sent_at": "2019-01-02T03:04:05.678123Z",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
    }
  ]
}

List Organization Memberships​

Use this to list the Organization Memberships for all users belonging to an organization. | key: listOrganizationMemberships

InputNotesExample
Connection

The Calendly connection to use.

Email

Indicates if the results should be filtered by email address

user@example.com
Organization

Indicates if the results should be filtered by organization

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
User

Indicates if the results should be filtered by user

https://api.calendly.com/users/UR1234567890

{
  "data": [
    {
      "uri": "https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA",
      "role": "admin",
      "user": {
        "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
        "name": "John Doe",
        "slug": "acmesales",
        "email": "test@example.com",
        "scheduling_url": "https://calendly.com/acmesales",
        "timezone": "America/New York",
        "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
        "created_at": "2019-01-02T03:04:05.678123Z",
        "updated_at": "2019-08-07T06:05:04.321123Z"
      },
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "created_at": "2019-01-02T03:04:05.678123Z"
    }
  ]
}

List Routing Form Submissions​

Get a list of Routing Form Submissions for a specified Routing Form. | key: listRoutingFormSubmissions

InputNotesExample
Connection

The Calendly connection to use.

Form

View routing form submissions associated with the routing form's URI.

https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA
Sort

Order results by the specified field and direction. Supported fields are: created_at. Sort direction is specified as: asc, desc.

{
  "data": [
    {
      "uri": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
      "routing_form": "https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA",
      "questions_and_answers": [
        {
          "question_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "question": "What is your industry?",
          "answer": "IT & Software"
        }
      ],
      "tracking": {
        "utm_campaign": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_content": null,
        "utm_term": null,
        "salesforce_uuid": null
      },
      "result": {
        "type": "event_type",
        "value": "https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2"
      },
      "submitter": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA",
      "submitter_type": "Invitee",
      "created_at": "2022-05-15T03:04:05.678Z",
      "updated_at": "2022-05-15T06:05:04.321Z"
    }
  ]
}

List Routing Forms​

Get a list of Routing Forms for a specified Organization. | key: listRoutingForms

InputNotesExample
Connection

The Calendly connection to use.

Organization

View organization routing forms associated with the organization's URI.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Sort

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.

created_at:desc

{
  "data": [
    {
      "uri": "https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "name": "ACME Demo",
      "status": "published",
      "questions": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "What is your industry?",
          "type": "select",
          "required": true,
          "answer_choices": [
            "IT & Software",
            "Financial Services",
            "Entertainment"
          ]
        },
        {
          "uuid": "1213f8f1-57fd-45ee-88e9-1978d35b5cad",
          "name": "Email",
          "type": "email",
          "required": true,
          "answer_choices": null
        }
      ],
      "created_at": "2022-05-15T03:04:05.678Z",
      "updated_at": "2022-05-15T06:05:04.321Z"
    }
  ]
}

List User Availability Schedules​

Returns the availability schedules of the given user. | key: listUserAvailabilitySchedules

InputNotesExample
Connection

The Calendly connection to use.

User

A URI reference to a user

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

{
  "data": {
    "collection": [
      {
        "uri": "https://api.calendly.com/user_availability_schedule/abc123",
        "default": true,
        "name": "Working Hours",
        "user": "https://api.calendly.com/users/abc123",
        "timezone": "America/New_York",
        "rules": [
          {
            "type": "wday",
            "intervals": [
              {
                "from": "08:30",
                "to": "09:30"
              }
            ],
            "wday": "sunday",
            "date": "2022-12-31"
          }
        ]
      },
      {
        "uri": "https://api.calendly.com/user_availability_schedule/abc456",
        "default": false,
        "name": "Evening Hours",
        "user": "https://api.calendly.com/users/abc123",
        "timezone": "America/New_York",
        "rules": [
          {
            "type": "wday",
            "intervals": [
              {
                "from": "08:30",
                "to": "17:00"
              }
            ],
            "wday": "monday"
          },
          {
            "type": "wday",
            "intervals": [
              {
                "from": "08:30",
                "to": "17:00"
              }
            ],
            "wday": "tuesday"
          },
          {
            "type": "wday",
            "intervals": [],
            "wday": "wednesday"
          },
          {
            "type": "wday",
            "intervals": [
              {
                "from": "08:30",
                "to": "17:00"
              }
            ],
            "wday": "thursday"
          },
          {
            "type": "wday",
            "intervals": [
              {
                "from": "08:30",
                "to": "17:00"
              }
            ],
            "wday": "friday"
          },
          {
            "type": "wday",
            "intervals": [],
            "wday": "saturday"
          },
          {
            "type": "date",
            "intervals": [
              {
                "from": "08:30",
                "to": "09:30"
              }
            ],
            "date": "2028-12-31"
          }
        ]
      }
    ]
  }
}

List User Busy Times​

Returns an ascending list of user internal and external scheduled events within a specified date range. | key: listUserBusyTimes

InputNotesExample
Connection

The Calendly connection to use.

End Time

End time of the requested availability range

2021-01-01T02:04:05.678123Z
Start Time

Start time of the requested availability range

2019-01-02T03:04:05.678123Z
User

The uri associated with the user

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

{
  "data": {
    "collection": [
      {
        "type": "calendly",
        "start_time": "2020-01-02T20:00:00.000000Z",
        "end_time": "2020-01-02T20:30:00.000000Z",
        "buffered_start_time": "2020-01-02T19:30:00.000000Z",
        "buffered_end_time": "2020-01-02T21:00:00.000000Z",
        "event": {
          "uri": "https://api.calendly.com/scheduled_events/abc123"
        }
      },
      {
        "type": "calendly",
        "start_time": "2020-01-05T20:00:00.000000Z",
        "end_time": "2020-01-05T20:30:00.000000Z",
        "buffered_start_time": "2020-01-05T19:30:00.000000Z",
        "buffered_end_time": "2020-01-05T21:00:00.000000Z",
        "event": {
          "uri": "https://api.calendly.com/scheduled_events/abc12345"
        }
      },
      {
        "type": "external",
        "start_time": "2020-01-07T20:00:00.000000Z",
        "end_time": "2020-01-07T20:30:00.000000Z"
      }
    ]
  }
}

List User's Event Types​

Returns all Event Types associated with a specified User. | key: listUserEventTypes

InputNotesExample
Active

When true, returns only active event types. When false, returns only inactive event types.

false
Admin Managed

When true, returns only admin managed event types. When false, excludes admin managed event types.

false
Connection

The Calendly connection to use.

Organization

View available personal, team, and organization event types associated with the organization's URI.

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Sort

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: name. Sort direction is specified as: asc, desc.

name:asc
User

View available personal, team, and organization event types associated with the user's URI.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ
User Availability Schedule

Used in conjunction with user parameter, returns a filtered list of Event Types that use the given primary availability schedule.

{
  "data": [
    {
      "uri": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
      "name": "15 Minute Meeting",
      "active": true,
      "booking_method": "instant",
      "slug": "acmesales",
      "scheduling_url": "https://calendly.com/acmesales",
      "duration": 30,
      "kind": "solo",
      "pooling_type": "round_robin",
      "type": "StandardEventType",
      "color": "#fff200",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z",
      "internal_note": "Internal note",
      "description_plain": "15 Minute Meeting",
      "description_html": "<p>15 Minute Meeting</p>",
      "profile": {
        "type": "User",
        "name": "Tamara Jones",
        "owner": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
      },
      "secret": true,
      "deleted_at": null,
      "admin_managed": false,
      "custom_questions": [
        {
          "name": "Company Name",
          "type": "string",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        },
        {
          "name": "What would you like to discuss?",
          "type": "text",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        },
        {
          "name": "Number of employees",
          "answer_choices": [
            "1",
            "2-10",
            "11-20",
            "20+"
          ],
          "enabled": true,
          "include_other": true,
          "position": 2,
          "required": false,
          "type": "single_select"
        },
        {
          "name": "Multi-Select Question",
          "answer_choices": [
            "Answer 1",
            "Answer 2",
            "Answer 3",
            "Answer 4"
          ],
          "enabled": true,
          "include_other": true,
          "position": 2,
          "required": false,
          "type": "multi_select"
        },
        {
          "name": "Phone Number",
          "type": "phone_number",
          "position": 0,
          "enabled": true,
          "required": true,
          "answer_choices": [],
          "include_other": false
        }
      ]
    }
  ]
}

List Webhook Subscription​

Get a list of Webhook Subscriptions for a specified Organization or User. | key: listWebhookSubscription

InputNotesExample
Connection

The Calendly connection to use.

Organization

Indicates if the results should be filtered by organization

https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ
Scope

Filter the list by organization or user

Sort

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.

User

Indicates if the results should be filtered by user. This parameter is only required if the scope parameter is set to user.

https://api.calendly.com/users/EBHAAFHDCAEQTSEZ

{
  "data": [
    {
      "uri": "https://api.calendly.com/webhook_subscriptions/AAAAAAAAAAAAAAAA",
      "callback_url": "https://blah.foo/bar",
      "created_at": "2019-08-24T14:15:22.123456Z",
      "updated_at": "2019-08-24T14:15:22.123456Z",
      "retry_started_at": "2019-08-24T14:15:22.123456Z",
      "state": "active",
      "events": [
        "invitee.created"
      ],
      "scope": "user",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "user": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA",
      "creator": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
    }
  ]
}

Raw Request​

Send raw HTTP request to Calendly | key: rawRequest

InputNotesExample
Connection

The Calendly connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/users/me), The base URL is already included (https://api.calendly.com). For example, to connect to https://api.calendly.com/users/me, only /users/me is entered in this field.

/users/me
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Remove User from Organization​

Removes a user from an organization. | key: removeUserFromOrganization

InputNotesExample
Connection

The Calendly connection to use.

UUID

The organization membership's unique identifier

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

Revoke User's Organization Invitation​

Use this to revoke an Organization Invitation to an organization. | key: revokeUserOrganizationInvitation

InputNotesExample
Connection

The Calendly connection to use.

Organization UUID

The organization's unique identifier.

UUID

The organization invitation's unique identifier.

9f53ccd3-88e6-4c62-ad9e-91ea57d2187d

Changelog​

2026-02-11​

Applied component standardization and enhanced data source capabilities:

  • Added debug support for API client operations
  • Enhanced data sources with optional UUID extraction capability

2025-10-17​

Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup