- Develop and test Intercom webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Intercom in real time via the inspection UI and API.
- Modify and replay Intercom webhook requests with a single click instead of reproducing events manually in your Intercom account.
- Secure your app with Intercom 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).
- An Intercom 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 Intercom.
3. Configure Intercom to send webhooks
Intercom can send webhook requests to your app when events occur in your account. To register for those events:- Sign in to Intercom.
- Click your avatar (below the What’s new bell icon) and then Settings.
If your avatar doesn’t appear, zoom out on the page.
- Under Apps & Integrations, click Developer Hub.
If the Developer Guidelines popup appears, click Accept and Continue.
- Click New App, enter a name, select your workspace, keep Internal integration selected, and click Create app.
- In your app, click Webhooks under Configure.
- Enter your ngrok URL in Your request endpoint URL (for example,
https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). - Select contact.user.created in Webhook topics and click Save.
Run webhooks with Intercom and ngrok
With contact.user.created selected, you can trigger calls by creating a user:- In Intercom, click Contacts.
- Click New, New users or leads, Create new user.
- Enter Name, Email, and User ID and click Create a user.
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 Intercom 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 the Intercom Developer Hub, click your app and then Basic information.
- Copy the Client secret value.
-
Create a Traffic Policy file named
intercom_policy.yml. Replace{your client secret}with the value you copied: -
Restart ngrok with the policy file:
- Create a new contact in Intercom to trigger the webhook.