Calendly does not currently offer a graphical user interface for webhook subscription setup. This guide will provide you with clear step-by-step instructions, starting with the authentication process. By the end of this guide, you'll be able to create and view webhook subscriptions in Calendly.
Create Webhook Subscription
Authentication
- Login to Calendly.
- Navigate to Integrations:
- Click on API and Webhooks:
- Generate and save Calendly personal access token:
Webhook Subscription
To create a webhook subscription in Calendly, you can utilize Postman, a versatile API testing and development tool. Postman will allow you to send API requests to Calendly and manage your webhook subscription effectively. We have prepared a Postman collection that includes all the necessary API requests to streamline the process.
Download and Install Postman
If you haven't already, download and install Postman from the Postman website. It's available for Windows, macOS, and Linux, and you can use the free version for this task.
Import the Calendly Webhook Subscription Collection
To simplify the process, we have created a Postman collection that contains all the required API requests. Here's how to import it:
- Download the Calendly Webhook Subscription Postman Collection from here.
- In Postman, click on the "Import" button in the top-left corner:
- Choose the downloaded file (the collection file), and it will be added to your Postman workspace.
Configure Calendly Webhook Subscription Collection
Now that you have imported the collection you can start using it to create and manage webhook subscriptions.
Step1. Get user details
- Select the "Calendly Webhook Subscription" collection from the left sidebar in Postman.
- Choose "1. Get Current User" request.
- Confirm request is configured with "GET" and "https://api.calendly.com/users/me"
- Navigate to Authentication.
- Select Bearer Token from the drop-down.
- Add the Calendly Bearer Token from the prior step.
- Click on Send to make the request.
- You should now see a list of variables.
- Copy the values for the following variables. They are required to create the webhook subscription:
-
current_organization
(e.g. "https://api.calendly.com/organizations/xxxxx") -
url
(e.g. "https://api.calendly.com/users/xxxxx")
-
Step 2. Create webhook subscription
- Choose "2. Create Subscription" request.
- Confirm request is configured with "POST" and "https://api.calendly.com/webhook_subscriptions"
- Navigate to Authentication.
- Select Bearer Token from the drop-down.
- Add the Calendly Bearer Token from the prior step:
- Navigate to Body.
- Replace values for the following variables.
-
-
organization
- replace withcurrent_organization
response from 1. Get Current User request -
user
- replace withurl
response from 1. Get Current User request -
url
- replace with the Act-On Incoming Webhook URL
-
-
- Choose the desired webhook events to subscribe to:
- invitee.created
- invitee.cancelled
- invitee_no_show.created
- Click Send to make the API request.
- You should now see a response confirming the webhook subscription was complete for the desired events:
Calendly Webhook Test Request
Now that you have created the subscription, you will need to test that the request is being sent to Act-On. This is a required step before the Incoming Webhook can be enabled in Act-On. There are two ways to send a test request:
Calendly
Simply schedule time using any of your Calendly scheduling links.
Postman
Import the Calendly Webhook Subscription Collection
- Download the Testing with Act-On Postman Collection from here.
- In Postman, click on the "Import" button in the top-left corner:
- Choose the downloaded file (the collection file), and it will be added to your Postman workspace.
Send Test Request
- Choose the "Testing with Act-On" request.
- Confirm request is configured with "POST" and Act-On Incoming Webhook URL.
- If Incoming Webhook requires Token Authentication, continue, otherwise skip to the next step.
- Navigate to Authentication.
- Select Bearer Token from the drop-down.
- Add Act-On Generated Token.
- Click on Send to make the request.