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

Install the Desktop Agent

Download and install the HookDeploy Desktop Agent on Windows and macOS, including SmartScreen and first-launch notes.

The Desktop Agent is the signed Windows/macOS app for running the HookDeploy agent from your system tray (Windows) or menu bar (macOS). Download it from the Download Agent control on the Agents page in the dashboard — the page offers the Windows installer and macOS disk images for Apple Silicon and Intel.

What’s included

The Desktop Agent runs the same underlying agent as the CLI and keeps it connected in the background. You can start taps from the app UI (including picking a local listening port) without typing commands. The CLI binary is still available on the machine for scripting and the full CLI reference.

Next: Using taps.