DocsLocal Development

Local Development

To test webhooks locally, you need a publicly accessible API endpoint. A common tool for this purpose is ngrok.

Installing ngrok

You can install ngrok by:

  1. Visiting their official website and downloading the application.
  2. Using a package manager such as npm:
    npm install -g ngrok

Running ngrok

After installation, you can use ngrok to expose your local server to the internet. For example, if your application runs on port 3000, you can use:

ngrok http 3000

This command will generate a random public URL that forwards requests to your local server.

Using a Static URL

For consistent testing, you may want to use a static URL. This can be configured in the ngrok dashboard. Static URLs simplify webhook testing by avoiding frequent URL updates.


Once set up, ensure your application is running locally and accessible via the ngrok-generated or static URL to successfully receive webhooks.