Ingest with ngrok

Ngrok is a tool that creates a secure tunnel to your localhost, allowing you to expose a local server to the internet. This is particularly useful for testing webhooks and other integrations that require a publicly accessible URL.

This guide is to help you test your webhooks locally using ngrok.

Create Your Ngrok Account

Go to Ngrok and create an account.

Install Ngrok

macOS

Install Ngrok on macOS

bash

brew install ngrok

Ubuntu/Debian

Install Ngrok on Ubuntu/Debian

bash

curl -s https://ngrok-agent.s3.amazonaws.com/ngrok.asc | \
  sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null && \
  echo "deb https://ngrok-agent.s3.amazonaws.com buster main" | \
  sudo tee /etc/apt/sources.list.d/ngrok.list && \
  sudo apt update && sudo apt install ngrok

Windows

Install Ngrok on Windows

bash

# Using Chocolatey
choco install ngrok

# Or download the installer from https://ngrok.com/download

Add Your Ngrok Token

bash

ngrok config add-authtoken $NGROK_TOKEN

Start Ngrok

bash

ngrok http http://localhost:3000

Grab your Forwarding Domain

Ngrok will generate a random https domain for you to use. This is the URL you will use to set up your webhook in SVIX.

Note: You can upgrade your ngrok account to generate static URLs.

Session Status                online
Account                       ethan.bonin@prahsys.com (Plan: Pro)
Update                        update available (version 3.22.1, Ctrl-U to update)
Version                       3.19.0
Region                        United States (us)
Latency                       54ms
Web Interface                 http://127.0.0.1:4040
Forwarding                    https://randomlyGeneratedDomain.ngrok.app -> http://localhost:8080

Connections                   ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00

Create an endpoint with Prahsys Webhooks

Create a new webhook in the Prahsys webhooks dashboard and use that domain as the Endpoint URL to listen for incoming webhook requests.

Create your webhook in SVIX

Test Your Webhook Connection

When pressing Send Example, it will send an example body to your ngrok tunnel which will forward it to your localhost.

Test your webhook in SVIX