Skip to main content

Celonis Product Documentation

Calendly

The Calendly modules enable you to monitor or retrieve events, invitees, event types, and memberships in your Calendly account.

Getting Started with Calendly

Prerequisites

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting Calendly to Integromat

1. Go to Execution Management System and open the Calendly module's Create a connection dialog.

61d5a9c041b61.gif

2. Enter a name for the connection to the Connection name field and click Continue.

3. After you click the Continue button, Integromat will redirect you to the Calendly website where you will be prompted to grant Integromat access to your account.

61d5a9c306363.png

Confirm the dialog by clicking the Connect to Calendly button.

Event
Watch Events

Triggers when an event is created or canceled.

1. Add the Watch Events module to your Integromat scenario.

2. Select events you want to watch.

3. Select or enter the Organization URI (requires) and User URI (optional) to filter returned data by. Click Save.

               You can retrieve Organization URI and User URI using the List Organization Memberships module:
            

Now, every time the specified event occurs, the Watch Events module in your Integromat scenario is triggered.

List Events

Retrieves events in your account by filter settings.

Connection

Establish a connection to your Calendly account.

Organization URI

Enter the organization URI to specify the organization to filter results by.

User URI

Enter the user URI to specify the user to filter results by.

Invitee Email

Enter the email address of the invitee to return events that are scheduled with the invitee associated with this email address.

Min Start Time

Enter the time and date to include events with start times after this time. See the list of supported date and time formats.

Max Start Time

Enter the time and date to include events with start times prior to this time. See the list of supported date and time formats.

Sort

Select the sort order of results by the specified field and direction.

Status

Filter results by the event status – whether the scheduled event is active or canceled.

Limit

Set the maximum number of events Integromat will return during one execution cycle.

List Event Invitees

Retrieves invitees of the specified event.

Connection

Establish a connection to your Calendly account.

Event

Select the event you want to retrieve invitees for.

Email

Enter the email address if the invitee to filter results by.

Sort

Select the sort order of results by the specified field and direction.

Status

Filter results by the invitee status – whether the invitee is still active or canceled.

Limit

Set the maximum number of invitees Integromat will return during one execution cycle.

List Event Types

Returns all event types associated with a specified user.

Connection

Establish a connection to your Calendly account.

User URI

Select the user to retrieve event types associated with the user.

Sort

Select the sort order of results by the specified field and direction.

Limit

Set the maximum number of event types Integromat will return during one execution cycle.

Get an Event

Retrieves event details.

Connection

Establish a connection to your Calendly account.

Event

Select the event or map the ID of the event you want to retrieve details for.

Get an Event Invitee

Retrieves details about an Invitee (person invited to an event).

Connection

Establish a connection to your Calendly account.

Enter an Event Invitee

Select whether to specify an invitee manually or select from the drop-down menu.

Invitee URI

Select the event or enter (map) the Invitee URI.

Get an Event Type

Retrieves event type details.

Connection

Establish a connection to your Calendly account.

Event Type

Select event type or enter (map) event type URI.

Schedule
Organization
List Organization Memberships

Retrieves the organization memberships for all users belonging to an organization.

Connection

Establish a connection to your Calendly account.

Organization URI

Enter the organization URI to retrieve all users that belong to the organization.

User URI

Enter the user URI to look up a user's membership in an organization.

Email

Enter the email address to filter results by.

Limit

Set the maximum number of organization memberships Integromat will return during one execution cycle.

Get an Organization Membership

Retrieves user's organization membership details.

Connection

Establish a connection to your Calendly account.

Organization Membership

Select or enter the organization membership URI you want to retrieve details for.

Invite a User to Organization

Invites a user to an organization.

Connection

Establish a connection to your Calendly account.

Organization URI

Enter (map) the organization URI where you want to add a user to.

Email Address

Enter the email address of the person you want to invite to the organization.

Make an API Call

Allows you to perform a custom API call.

Connection

Establish a connection to your Calendly account.

URL

                           Enter a path relative to https://api.calendly.com.
For example: /users/me.
                        

For the list of available endpoints, refer to the Calendly API Documentation.

Method

Select the HTTP method you want to use:

                           GET
to retrieve information for an entry.
                        
                           POST
to create a new entry.
                        
                           PUT
to update/replace an existing entry.
                        
                           PATCH
to make a partial entry update.
                        
                           DELETE
to delete an entry.
                        

Headers

Enter the desired request headers. You don't have to add authorization headers; we added those for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Organization Event Types

The following API call returns all event types that belong to the organization in your Calendly account:

               URL:
/event_types
            
               Method:
GET
            
               Method:
Key: organization
Value: {organization URI}
            
               The result can be found in the module's Output under Bundle > Body > collection. 
In our example, 3 event types were returned:
            
Changelog

New modules:

  • Create a Scheduling Link

  • Get an Event

  • Get an Event Invitee

  • Get an Event Type

  • Get an Organization Membership

  • Invite a User to Organization

  • List Event Invitees

  • List Events

  • List Event Types

  • List Organization Memberships

  • Make an API Call

Changes:

  • Watch Cancellations module deprecated, you can use the improved Watch Events

  • Watch Invitee Events module deprecated

  • Watch Events now also allows for filtering of Invitee Canceled, before it was only Invitee Created