- Develop and test Mailgun webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Mailgun in real time via the inspection UI and API.
- Modify and replay Mailgun webhook requests with a single click instead of reproducing events manually in your Mailgun account.
- Secure your app with Mailgun 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 Mailgun 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 Mailgun.
3. Configure Mailgun to send webhooks
Mailgun can send webhook requests to your app when events occur in your account. To register for those events:- Sign in to Mailgun.
- Click Sending, Webhooks, and then Add webhook.
- On the New webhook popup, select Delivered Messages in Event type, enter your ngrok URL in URL (for example,
https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). - Click Create webhook.
Run webhooks with Mailgun and ngrok
Mailgun sends different request body contents depending on the event. To trigger new calls from Mailgun to your app:- In the Mailgun Dashboard, go to Sending and Overview.
- In Authorized Recipients, enter a valid email and click Save Recipient.
- Have the recipient confirm by clicking the link in the email from Mailgun.
-
Send an email (for example, via the Mailgun API). Replace placeholders with values from your account (API base URL and API Key from Overview, your domain from Domains, and the authorized recipient email):
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 Mailgun 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 Mailgun, go to Sending and Webhooks.
- Click the eye icon next to HTTP webhook signing key and copy the value.
-
Create a Traffic Policy file named
mailgun_policy.yml. Replace{webhook signing key}with the value you copied: -
Restart ngrok with the policy file:
- Send a new email to an authorized recipient to trigger the webhook.