Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hasura Webhook. 1st commit #611

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/integrations/hasura/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: hasura
title: Hasura Integration Hub
sidebar_label: Hasura
description: |
Easily capture database events within your Hasura account and foward them to HTTP webhooks.
All with security and access from ngrok.
excerpt: |
Easily capture database events and foward them to HTTP webhooks using ngrok.
---

import IntegrationPageList from "@site/src/components/IntegrationPageList";

<p>{frontMatter.description}</p>

<IntegrationPageList name={frontMatter.name} />
136 changes: 136 additions & 0 deletions docs/integrations/hasura/webhooks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
description: Develop and test Hasura webhooks from localhost
---

# Hasura Webhooks

:::tip TL;DR

To integrate Hasura webhooks with ngrok:

1. [Launch your local webhook.](#start-your-app) `npm start`
1. [Launch ngrok.](#start-ngrok) `ngrok http 3000`
1. [Configure Hasura webhooks with your ngrok URL.](#setup-webhook)
1. [Secure your webhook requests with verification.](#security)

:::

This guide covers how to use ngrok to integrate your localhost app with Hasura by using Webhooks.
Hasura webhooks can be used to run some custom business logic whenever Hasura triggers an event on your databases.

By integrating ngrok with Hasura, you can:

- **Develop and test Hasura 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 Hasura** in real-time via the inspection UI and API.
- **Modify and Replay Hasura Webhook requests** with a single click and without spending time reproducing events manually in your Hasura account.
- **Secure your app with Hasura validation provided by ngrok**. Invalid requests are blocked by ngrok before reaching your app.

## **Step 1**: Start your app {#start-your-app}

For this tutorial, we'll use the [sample NodeJS app available on GitHub](https://github.com/ngrok/ngrok-webhook-nodejs-sample).

To install this sample, run the following commands in a terminal:

```bash
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:

```bash
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 {#start-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](https://ngrok.com/signup).

1. [Download the ngrok agent](https://ngrok.com/download).

1. Go to the [ngrok dashboard](https://dashboard.ngrok.com) and copy your Authtoken. <br />
**Tip:** The ngrok agent uses the auth token to log into your account when you start a tunnel.
1. Start ngrok by running the following command:

```bash
ngrok http 3000
```

1. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Hasura).
![ngrok agent running](/img/integrations/launch_ngrok_tunnel.png)

## **Step 3**: Integrate Hasura {#setup-webhook}

To register a webhook on your Hasura account follow the instructions below:
**Note**: You must have previously configured a database with your Hasura account project.

1. Access [Hasura](https://cloud.hasura.io/) and sign in using your Hasura account.

1. On the **Projects** page, click **Launch Console** for your project, click **Events** on the top menu, and then click **Create** on the **Event Triggers** page.

1. On the **Create a new event trigger** page, enter `MyNgrokTrigger` in the **Trigger Name** field, select your **Database**, the **Schema**, and the **Table**.

1. On the **Trigger Operations** section select **Insert**, **Update**, and **Delete**.

1. On the **Webhook (HTTP/S) Handler** field 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`).
![Webhook URL](img/ngrok_url_configuration_hasura.png)

1. Scroll down and click **Create Event Trigger**.


### Run Webhooks with Hasura and ngrok

Hasura sends different request body contents depending on the event that is being triggered.
You can trigger new calls from Hasura to your application by following the instructions below.

1. Access your database and insert a row.

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

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

1. Click **Invocation Logs** on the trigger page, expand the event row by clicking the squared icon, and verify the **Request** tab:
![Webhook Logs](img/ngrok_logs_hasura.png)


### 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 Hasura'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 Hasura.

From the results, review the response body, header, and other details:

![ngrok Request Inspector](img/ngrok_introspection_hasura_webhooks.png)


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

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

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

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

1. Click **Replay**.

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

Loading