- Develop and test Calendly webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Calendly in real time via the inspection UI and API.
- Modify and replay Calendly webhook requests with a single click instead of reproducing events manually in your Calendly account.
- Secure your app with Calendly webhook validation provided by ngrok. Invalid requests are blocked by ngrok before reaching your app.
What you’ll need
- An ngrok account and your authtoken.
- The ngrok agent installed.
- Node.js installed (for the sample app, or use your own app).
- A Calendly account.
1. Start your app
For this tutorial, you can use the sample Node.js app on GitHub. To install the sample, run the following in a terminal:http://localhost:3000.
The app logs request headers and body in the terminal and shows a message in the browser.
2. Expose your app with ngrok
Once your app is running locally, you’re ready to put it online securely using ngrok.- Copy your ngrok authtoken from the dashboard.
-
Start ngrok:
- Copy the URL ngrok displays. Your app is now exposed at that URL for use with Calendly.
3. Configure Calendly to send webhooks
Calendly can send webhook requests to your app when events occur in your account. To register for those events:- Sign in to Calendly.
- On the My Calendly page, click Integrations in the top menu.
- On the All integrations page, click the API and webhooks tile and then click Get a token under the Personal access tokens section.
- On the Before you begin popup, click Continue, enter a name for the token in the Choose a name for this token field, click Create token, click Copy token, and then click Close.
- On the Your personal access tokens page, scroll down and click Copy Key in the API Key section.
-
Open a terminal and run the following to get your account info:
Replace
TOKENwith the token value you copied. - Copy the value of the current_organization field and the uri field from the response.
-
Run the following to register the webhook:
Replace
URLwith your ngrok URL (for example,https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app),TOKENwith the Calendly token,ORGANIZATION_URLwith the current_organization value,USER_URLwith the uri value, andKEYwith the key you copied. - Confirm the response contains a resource attribute with the information you provided.
Run webhooks with Calendly and ngrok
Calendly sends different request body contents depending on the event. To trigger new calls from Calendly to your app:- Use your Calendly link to schedule a meeting (for example, click 30 Minutes Meeting, select a date, and click Confirm).
If you don’t know your Calendly link, go to Calendly, click Account in the top right, click Share Your Link, and copy your link.
- On the Enter Details page, enter your name and email and click Schedule Event.
Inspecting requests
ngrok’s Traffic Inspector captures all requests made through your ngrok endpoint to your localhost app. Select any request to view detailed information about both the request and response.To avoid exposing secrets, accounts only collect traffic metadata by default.
You must enable full capture in the Observability section of your account settings to capture complete request and response data.
- Validate webhook payloads and response data
- Debug request headers, methods, and status codes
- Troubleshoot integration issues without adding logging to your app
Replaying requests
Test your webhook handling code without triggering new events from your service using the Traffic Inspector’s replay feature:- Send a test webhook from your service to generate traffic in your Traffic Inspector.
- Select the request you want to replay in the traffic inspector.
-
Choose your replay option:
- Click Replay to send the exact same request again
- Select Replay with modifications to edit the request before sending
- (Optional) Modify the request: Edit any part of the original request, such as changing field values in the request body.
- Send the request by clicking Replay.
Secure webhook requests
ngrok can verify that incoming requests are from your Calendly webhook so only that traffic reaches your app.Webhook verification is limited to 500 validations per month on free accounts.
If you need more, you can upgrade to Hobbyist or Pay-as-you-go.
See TPU Pricing for details.
- In Calendly, go to Integrations, API and webhooks, and copy the API Key value (the same value you used to register your webhook).
-
Create a Traffic Policy file named
calendly_policy.yml. Replace{your key}with the value you copied: -
Restart ngrok with the policy file:
- Schedule a meeting from your Calendly link to trigger the webhook.