HostedHooks Webhooks

TL;DR

To integrate HostedHooks webhooks with ngrok:

1. Launch your local webhook. npm start
2. Launch ngrok. ngrok http 3000
3. Configure HostedHooks webhooks with your ngrok URL.
4. Secure your webhook requests with verification.

This guide covers how to use ngrok to integrate your localhost app with HostedHooks by using Webhooks. HostedHooks webhooks can be used to route requests to HostedHooks servers to your localhost app.

By integrating ngrok with HostedHooks, you can:

• Develop and test HostedHooks 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 HostedHooks in real-time via the inspection UI and API.
• Modify and Replay HostedHooks Webhook requests with a single click and without spending time reproducing events manually in your HostedHooks account.
• Secure your app with HostedHooks 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!

1. If you're not an ngrok user yet, just sign up for ngrok for free.

2. Download the ngrok agent.

3. 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.

4. Start ngrok by running the following command:

   ngrok http 3000

5. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with HostedHooks).

Step 3: Integrate HostedHooks

To register a webhook on your HostedHooks account follow the instructions below:

1. Access HostedHooks and sign in using your HostedHooks account.

2. Click Apps on the left menu, and then click Setup New App.

3. On the Setup Your Application page, enter My App in the App Name field and then click Save App.

4. On the app page, click Create Your Webhook Event (Step 1), enter myapp.event in the Event Type field, and then click Save Webhook Event.

5. On the app page, click Create your first Subscriber (Step 2), enter My Localhost App in the Subscription Name field, and then click Save Subscription.

6. On the My Localhost App Subscription page, click + New Endpoint.

7. On the New Endpoint page, 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).

8. Enter 1.0 in the Version field, enter ngrok in the Description field, and then click Save Endpoint.

9. Click the left arrow to go back to the app page and then click Subscribe to a webhook event (Step 4).

10. On the Details page, select myapp.event in the Subscribed Events selector and then click Add Event.

11. Click the left arrow twice to go back to the app page and then click Send a test webhook message.

    Confirm your localhost app receives the myapp.event event notification and logs both headers and body in the terminal.

Run Webhooks with HostedHooks and ngrok

Whenever you post a message to the HostedHooks message endpoint using the value myapp.event as the event type inside the body of the request, HostedHooks routes this message to your localhost app through your ngrok URL. You can trigger new calls from HostedHooks to your application by following the instructions below.

1. Open a terminal window and run the following command:

   curl --request POST --url https://hostedhooks.com/api/v1/apps/APP_ID/messages
   \
   --header 'Authorization: Bearer API_KEY' \
   --header 'Content-Type: application/json' --data '{
       "data": {
           "foo": "bar"
       },
       "event_type": "myapp.event",
       "version": "1.0",
       "event_id": "00001"
   }'

   Note: Replace the following with the corresponding values:

   • APP_ID: The ID of your application. Copy the value from your app page on HostedHooks, in the My App section.
   • API_KEY: The API Key value from the Settings page on HostedHooks.

   Confirm your localhost app receives the event notification and logs both headers and body in the terminal.

Alternatively, you can verify the log of the webhook call in HostedHooks:

1. Access the HostedHooks Dashboard, click Apps on the left menu, and then click your app tile.

2. On your app page, scroll down to the Inbound Messages section and verify the messages sent to your app.

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.app for free accounts or ngrok.app for 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 HostedHooks' webhooks call, launch the ngrok web interface (i.e. http://127.0.0.1:4040), and then click one of the requests sent by HostedHooks.

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 HostedHooks. To replay a request:

1. In the ngrok inspection interface (i.e. http://localhost:4040), select a request from HostedHooks.

2. 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.

3. If you choose to Replay with modifications, you can modify any content from the original request. For example, you can modify the type field inside the body of the request.

4. Click Replay.

Verify that your local application receives the new 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 HostedHooks 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.

1. Access the HostedHooks Dashboard, click Apps on the left menu, and then click your app tile.

2. On the app page, click View in the Subscribers section and click View in the Endpoints section.

3. On the Endpoint page, click Reveal in the Signing Secret field and copy the value that appears.

4. Restart your ngrok agent by running the command, replacing {app sign secret} with the value you copied before:

   ngrok http 3000 --verify-webhook hostedhooks --verify-webhook-secret {app sign secret}

5. Post a new message to the message endpoint of HostedHooks by following the same procedure as the Run Webhooks with HostedHooks and ngrok section. Tip: Modify the value of the event_id field in the JSON body. This value must be unique per app.

Verify that your local application receives the request and logs information to the terminal.