Connectors / Service / Calendly

Calendly helps you schedule meetings without the back-and-forth emails. (updated: 1633093264684)

Calendly

Meeting Scheduling Software

Overview

Calendly helps you schedule meetings without the back-and-forth emails.

API INFO: The Base URL used for the calendly connector is https://api.calendly.com. More information can be found on their main API documentation (v2.0) site.

Authentication

Within the workflow builder, highlight the Calendly connector.

In the Calendly connector properties panel to the right of the builder, click on the Authenticate tab and the 'New authentication' button.

calendly-auth-1

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

The next page will ask you to select the type of authentication you wish to create. This is either 'Token-based' or 'Oauth 2.0'

calendly-select-auth

1 - Oauth 2.0 Authentication

Suppose you choose to create an OAuth 2.0 authentication. A login window will pop up, and you will be asked to sign in with Calendly credentials. This is the 'Email address' and 'Password' of your Calendly account.

calendly-auth-oauth-popup

2 - Token-based authentication

If you choose to create a token-based authentication, you will need to enter the access token.

You will need to enter your Calendly Access Token key.

calendly-auth-token-based-popup

In order to get these fields, head to the Calendly dashboard. Click on the 'Integrations' menu available on the top right corner of the page.

calendly-auth-step-1

Select 'API & Webhooks' from the options.

calendly-auth-step-2

You will now be able to generate your access token.

calendly-auth-step-3

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the available drop-down options.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 2.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Calendly which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Calendly API documentation, to find the exact format that Calendly will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Calendly is: https://api.calendly.com

For example, say that the Get current user' operation did not exist in our Calendly connector, and you wanted to use this endpoint. You would use the Calendly API docs to find the relevant endpoint - which in this case is a GET request called: /users/me.

More details about this endpoint can be found here.

calendly-get-url

There is also the option to include a query parameter, should you wish to do so. So if you know what your method, endpoint and details of your query parameters are, you can make a call to the endpoint with the following settings:

Method: GET

Endpoint: /users/me

Final outcome being: https://api.calendly.com/users/me

calendly-raw-http

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the calendly connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Calendly connector, to list events in Calendly.

The steps will be as follows:

  1. Setup using a manual trigger and a Calendly connector with the 'Get personal information' operation.

  2. Add another Calendly connector, with the 'List events' operation.

The final outcome should look like this:

calendly-basic-workflow-1

1 - Setup Trigger and Get personal information

Once you have clicked 'Create new workflow' from your main Tray.io dashboard named it, select the Manual trigger from the trigger options available:

calendly-manual-trigger

After you have been redirected to the Tray.io workflow dashboard, from the connectors panel on the left, add a Calendly connector to your second step. Set the operation to 'Get personal information'.

calendly-step-1

Feel free to re-name your steps as you go along to make things clearer for yourself and other users.

Now, when this workflow is run, it will retrieve the user's personal information from the API.

2 - List event types

Next, add another Calendly connector to your workflow. Set your operation to 'list event types'.

You will notice there are a lot of parameters for this operation. From the description of this operation, it is stated that either the 'User URI' or 'Organisation URI' are required. Many of the values for these fields can be retrieved from the output of step 1.

Since you are getting the user information from the 'Get person information', you will have access to the 'URI'

Use the connector-snake to find the jsonpath for the 'User URI' field from 'step 1'. It should appear similar to this: $.steps.calendly-1.resource.uri.

calendly-step-2

For more clarification on the pathways, you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

This will enable us to list events types.

calendly-output

Click on the Debug tab to view Input and Output for individual steps.

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

2.0

Get personal information

Retrieve basic information about your user account.

List event types

Retrieve a list of event types. Provide either 'User URI' or 'Organization URI'.

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.