Development Workflow

Why use Hookdeck in development

Developing webhook integrations comes with a series of challenges we aim to address

Receiving webhooks on your local server

Using the Hookdeck CLI, you can forward your webhooks to your local webserver. We offer unlimited free and permanent webhook URLs.

Hookdeck CLI is compatible with most of Hookdeck features such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your webhook integration code locally.

Although it uses a different approach and philosophy, it's a replacement for ngrok and alternative HTTP tunnel solutions.

Coordinating with your teammates

When using ngrok or a similar solution, teams end up having to coordinate to avoid flooding each other with unwanted webhooks. Using Hookdeck, each team member receives their own copy of a webhook and the history is isolated per team member. Each team member can also listen to only relevant events to what they are working on instead of all the webhooks received to a given URL.

Additionally, events can be shared with your teammates to troubleshoot issues.

Preserve your event history between session and replay them

Your webhook history is preserved between sessions and can be viewed, replayed or used for testing by you and your teammates. We offer a best-in-class UI to browse your event logs and inspect the request and response data.

Use your hookdeck event history in your integration tests

You can use your webhook event history as mock data for your integration tests instead of keeping stale JSON checking in your repo.


How to use Hookdeck for development

Getting your Webhook URLs

Hookdeck works by routing webhooks receive for a given source (ie: Shopify, Github, etc.) to its defined destination by connecting them with a connection to a destination. The CLI allows you to receive webhooks for any given connection and forward them to your localhost at the specified port.

Each source is assigned a Webhook URL, which you can use to receive webhooks. When starting with a fresh account, the CLI will prompt you to create your first source. Each CLI process can listen to one source at a time.

You can create a Webhook URL by creating a new source with the Dashboard or the CLI.

Receiving your webhooks locally

To receive your webhooks locally, download and run the Hookdeck CLI

Read about how to use the CLI to learn about the different ways you can tap into your webhooks.

Browsing your events

Events sent to your CLI are available on https://dashboard.hookdeck.com/events/cli. Within the UI, you can filter and browse the events. Like for production events, the request data and the response data are available by clicking any events. Furthermore, you can retry any events to replay them locally.