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

Overview

What the HookDeploy CLI and Desktop Agent are, how they relate, and when to use each.

The HookDeploy agent delivers captured webhooks to a machine you control — a laptop, a staging box, or a server behind a firewall — without opening inbound ports. The agent dials out to HookDeploy, stays connected, and receives traffic destined for it.

There are two ways to run that same agent:

  • CLI (hookdeployed) — a single binary you install and run from a terminal. Best for servers, CI, and headless Linux hosts.
  • Desktop Agent — a signed Windows/macOS app that runs the same agent as a background process and gives you a system tray / menu bar UI for login, status, and taps.

They share the same enrollment, connection, and delivery behavior. The Desktop Agent also bundles the CLI for advanced use on the same machine.

When to use which

SituationPrefer
Always-on Linux server or VMCLI
Scripted / non-interactive provisioningCLI with an enrollment token
Windows or macOS laptop / desktopDesktop Agent (CLI is included)
Quick local taps while developingEither — Desktop Agent is usually faster to start; CLI is fine if you already live in a terminal

What you do next

  1. Install the CLI on Linux, or install the Desktop Agent on Windows/macOS.
  2. Enroll the machine into your organization (token or browser login).
  3. Keep it connected, then use taps when you need a temporary local mirror of live traffic.

Choose Production or Development when you enroll — see Production vs Development for how that affects retries and plan limits.