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
- A Calendly account — you can create one at calendly.com/signup.
Connecting Calendly to Ibexa Connect¶
1. Go to Ibexa Connect and open the Calendly module's Create a connection dialog.
2. Enter a name for the connection to the Connection name field and click Continue.
After you click the Continue button, Ibexa Connect will redirect you to the Calendly website where you will be prompted to grant Ibexa Connect access to your account.
3. Confirm the dialog by clicking the Connect to Calendly button.
The connection has been established.
Event¶
Watch Events¶
Triggers when an event is created or canceled.
1. Add the Watch Events module to your Ibexa Connect 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 Ibexa Connect scenario is triggered.
List Events¶
Retrieves events in your account by filter settings.
| 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 Ibexa Connect will return during one execution cycle. |
List Event Invitees¶
Retrieves invitees of the specified event.
| Event | Select the event you want to retrieve invitees for. |
| Enter the email address of the invitee to filter results. | |
| 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 Ibexa Connect will return during one execution cycle. |
List Event Types¶
Returns all event types associated with a specified user.
| 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 Ibexa Connect will return during one execution cycle. |
Get an Event¶
Retrieves event details.
| 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).
| 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.
| Event Type | Select event type or enter (map) event type URI. |
Schedule¶
Create a Scheduling Link¶
Creates a scheduling link.
| Maximum Event Count | Enter the maximum number of events that can be scheduled using this scheduling link. |
| Event Type | Select event type or enter (map) event type URI. |
Organization¶
List Organization Memberships¶
Retrieves the organization memberships for all users belonging to an organization.
| 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. |
| Enter the email address to filter results by. | |
| Limit | Set the maximum number of organization memberships Ibexa Connect will return during one execution cycle. |
Get an Organization Membership¶
Retrieves user's organization membership details.
| 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.
| 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.
URL |
Enter a path relative to For example: For the list of available endpoints, refer to the Calendly API Documentation. |
Method |
Select the HTTP method you want to use:
|
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
Query string:
Key: organization
Value: {organization URI}
The result can be found in the module's Output under Bundle > Body > collection.
In our example, 4 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