- Develop and test Zendesk webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Zendesk in real time via the inspection UI and API.
- Modify and replay Zendesk webhook requests with a single click instead of reproducing events manually in your Zendesk account.
- Secure your app with Zendesk 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 Zendesk 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 Zendesk.
3. Configure Zendesk to send webhooks
Zendesk can send webhook requests to your app when automation rules run. To set it up:- Sign in to Zendesk, go to Admin (gear icon) > Admin Center.
- Click Apps and integrations > Webhooks > Create Webhooks.
- On Create webhook, enter a Name and your ngrok URL in Endpoint URL (for example,
https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). - Set Request method to POST and Request format to JSON (for production you can add Basic or Bearer authentication; for this tutorial use None).
- Click Test webhook > Send test, confirm your app receives the request, then click Create.
- Create an automation: Objects and rules > Automations > Add automation. Set title, conditions (e.g. Ticket is Created, Type is Incident, Priority is High), and under Perform these actions add Notify webhook with a JSON body (e.g.
{"message":"{{ticket.requester.name}} we are setting your ticket {{ticket.title}} to urgent priority."}). Click Create automation.
Run webhooks with Zendesk and ngrok
With the automation above, a high-priority incident ticket triggers the webhook:- In Zendesk, click + Add > Ticket.
- Set Requester, Type to Incident, Priority to High, enter a subject, and click Submit as New.
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 Zendesk 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 Zendesk, go to Admin Center > Apps and integrations > Webhooks and click your webhook.
- Click Reveal secret and Copy to copy the Secret key.
-
Create a Traffic Policy file named
zendesk_policy.yml. Replace{your secret key}with the value you copied: -
Restart ngrok with the policy file:
- Create another high-priority incident ticket (as in Run webhooks with Zendesk and ngrok) to trigger the webhook.