- Develop and test Zoom webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Zoom in real time via the inspection UI and API.
- Modify and replay Zoom webhook requests with a single click instead of reproducing events manually in your Zoom account.
- Secure your app with Zoom 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 Zoom 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 Zoom.
3. Configure Zoom to send webhooks
Zoom can send webhook requests to your app when meeting and other events occur. This guide uses the Webhook Only app type (free Zoom account).- Sign in to the Zoom Marketplace.
- Click Develop > Build App, select Webhook Only, enter a Name, and click Create.
- Complete registration with Company Name, developer Name, and Email, then click Continue.
- On Feature, turn Event subscriptions on and click Add Event Subscriptions.
- Enter your ngrok URL in Event notification endpoint URL (for example,
https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). - Copy the Secret Token for use in verification.
- Click Add Events, select events (e.g. Start Meeting, End Meeting), click Done, then Save and Continue.
- When you see Your app is activated on the account, Zoom is ready to send events. You can review the webhook under Manage on the Marketplace page.
Run webhooks with Zoom and ngrok
After the webhook is added, start a meeting in your Zoom account and end it after a few seconds. Your localhost app receives notifications for both events. You can review Manage > Call Logs > Webhook Logs in the Marketplace to compare request bodies with what your app received.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 Zoom 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.
- Use the Secret Token you copied when configuring the webhook (see Configure Zoom to send webhooks).
-
Create a Traffic Policy file named
zoom_policy.yml. Replace{your secret token}with that value: -
Restart ngrok with the policy file:
- Start and then end a meeting in Zoom to trigger the webhook.