Clearbit Webhooks
To integrate Clearbit webhooks with ngrok:
This guide covers how to use ngrok to integrate your localhost app with Clearbit by using Webhooks. Clearbit webhooks can be used to notify an external application whenever specific events occur in your Clearbit account.
By integrating ngrok with Clearbit, you can:
- Develop and test Clearbit webhooks locally, eliminating the time in deploying your development code to a public environment and setting it up in HTTPS.
- Inspect and troubleshoot requests from Clearbit in real-time via the inspection UI and API.
- Modify and Replay Clearbit Webhook requests with a single click and without spending time reproducing events manually in your Clearbit account.
- Secure your app with Clearbit validation provided by ngrok. Invalid requests are blocked by ngrok before reaching your app.
Step 1: Start your app
For this tutorial, we'll use the sample NodeJS app available on GitHub.
To install this sample, run the following commands in a terminal:
git clone https://github.com/ngrok/ngrok-webhook-nodejs-sample.git
cd ngrok-webhook-nodejs-sample
npm install
This will get the project installed locally.
Now you can launch the app by running the following command:
npm start
The app runs by default on port 3000.
You can validate that the app is up and running by visiting http://localhost:3000. The application logs request headers and body in the terminal and responds with a message in the browser.
Step 2: Launch ngrok
Once your app is running successfully on localhost, let's get it on the internet securely using ngrok!
If you're not an ngrok user yet, just sign up for ngrok for free.
Go to the ngrok dashboard and copy your Authtoken.
Tip: The ngrok agent uses the auth token to log into your account when you start a tunnel.Start ngrok by running the following command:
ngrok http 3000ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Clearbit).
Step 3: Integrate Clearbit
To register a webhook on your Clearbit account follow the instructions below:
Access the Clearbit API Dashboard and sign in using your Clearbit account.
On the API Settings section, enter the URL provided by the ngrok agent to expose your application to the internet in the Webhook URL field (i.e.
https://1a2b-3c4d-5e6f-7g8h-9i0j.sa.ngrok.io).
Click Update account.
Make note of the value of the Secret API Key that appears on the Clearbit API Dashboard page. Note: Usually the secret key value starts with
sk_.
Run Webhooks with Clearbit and ngrok
Clearbit sends different request body contents depending on the event that is being triggered. You can trigger new calls from Clearbit to your application by following the instructions below.
Open a terminal window and run the following command to gather information about your account:
curl --request GET --url https://person.clearbit.com/v1/people/email/EMAIL_ADDRESS \
--header 'Authorization: Bearer TOKEN'Note: Replace the following with values copied on previous steps:
- EMAIL_ADDRESS: An email address of a user in your Clearbit account organization.
- TOKEN: The Clearbit secret key you copied before.
Confirm your localhost app receives a notification and logs both headers and body in the terminal.
Inspecting requests
When you launch the ngrok agent on your local machine, you can see two links:
- The URL to your app (it ends with
ngrok-free.appfor free accounts orngrok.appfor paid accounts when not using custom domains) - A local URL for the Web Interface (a.k.a Request Inspector).
The Request Inspector shows all the requests made through your ngrok tunnel to your localhost app. When you click on a request, you can see details of both the request and the response.
Seeing requests is an excellent way of validating the data sent to and retrieved by your app via the ngrok tunnel. That alone can save you some time dissecting and logging HTTP request and response headers, methods, bodies, and response codes within your app just to confirm you are getting what you expect.
To inspect Clearbit's webhooks call, launch the ngrok web interface (i.e. http://127.0.0.1:4040), and then click one of the requests sent by Clearbit.
From the results, review the response body, header, and other details:
Replaying requests
The ngrok Request Inspector provides a replay function that you can use to test your code without the need to trigger new events from Clearbit. To replay a request:
In the ngrok inspection interface (i.e.
http://localhost:4040), select a request from Clearbit.Click Replay to execute the same request to your application or select Replay with modifications to modify the content of the original request before sending the request.
If you choose to Replay with modifications, you can modify any content from the original request. For example, you can modify the id field inside the body of the request.
Click Replay.
Verify that your local application receives the request and logs the corresponding information to the terminal.
Secure webhook requests
The ngrok signature webhook verification feature allows ngrok to assert that requests from your Clearbit webhook are the only traffic allowed to make calls to your localhost app.
Note: This ngrok feature is limited to 500 validations per month on free ngrok accounts. For unlimited, upgrade to Pro or Enterprise.
This is a quick step to add extra protection to your application.
Access the Clearbit API Dashboard and sign in using your Clearbit account.
Copy the value of the Secret API Key field that appears on the screen. Note: Usually the secret key value starts with
sk_.Restart your ngrok agent by running the command, replacing
{your api key}with the value you copied before:ngrok http 3000 --verify-webhook clearbit --verify-webhook-secret {your api key}Repeat the command to gather information about your account.
Verify that your local application receives the request and logs the information to the terminal.