Skip to content
HookDeploy
HookDeployDocumentation
On this page ↓
Getting startedIntroduction

What HookDeploy is, who it's for, and the core concepts behind webhook capture and replay.

→Getting startedQuickstart

From signup to your first captured webhook in under five minutes.

→Getting startedYour first endpoint

Create an endpoint, copy its URL, send test requests, and read the request inspector.

→Core conceptsForwarding

Forward captured webhooks to one or more destinations, with optional payload transformation.

→Core conceptsTransformations

Reshape webhook payloads before forwarding with the visual editor, 35 built-in formatters, conditions, and form-encoded support.

→Core conceptsPrivacy filters

Reshape or redact webhook payloads before HookDeploy stores them ΓÇö without changing what forward destinations receive.

→Core conceptsCustom Responses

Override the HTTP response HookDeploy returns to webhook senders. Set a custom status code, response body, and dynamic variables for testing and mocking.

→Core conceptsEndpoint security

Restrict access to your HookDeploy endpoints with IP allowlists and secret token authentication.

→
↑↓ navigateEnter openEsc close

Using taps

Temporary local mirroring of live webhook traffic from the CLI or Desktop Agent.

A tap is a temporary local mirror of live traffic: HookDeploy continues delivering to real destinations as usual, and an extra copy is sent to a port and path on your machine for debugging.

You can tap:

  • An endpoint (raw inbound shape), or
  • A destination (the same transformation rules as that destination)

Taps are meant for development machines. They expire automatically (default and maximum 8 hours). You can stop one earlier with the CLI or the Desktop Agent UI.

Start a tap from the CLI

You need hookdeployed connect running on the same machine so deliveries can land.

hookdeployed tap list
hookdeployed tap <endpoint-id> -port 3000 -path /hooks
hookdeployed tap <endpoint-id> <destination-id> -port 3000 -path /webhooks/stripe -duration 2h

tap list shows what you can tap and which taps are already active. Ctrl+C (or hookdeployed tap stop) ends the tap you started in the foreground.

Full flags: CLI reference.

Start a tap from the Desktop Agent

In the Desktop Agent, open Taps (or use Tap on an endpoint). The app lets you choose a local listening port and path, then starts the tap without typing IDs by hand. Stop it from the same UI when you’re done.

While the agent is offline

A tap stays configured until it expires or you stop it — going offline does not clear it. Deliveries only land on your machine while the agent is connected (hookdeployed connect or the Desktop Agent staying online). When the agent reconnects before expiry, mirrored traffic can resume for that same tap.