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 CLI

Install hookdeployed on Linux with the APT repo or the GitHub install script, including non-interactive enrollment.

The CLI installers below target Linux. On Windows and macOS, most people use the Desktop Agent, which bundles hookdeployed. Raw binaries for Linux, macOS, and Windows are also published on GitHub Releases for advanced or scripted setups.

Generate a one-time enrollment token from the Linux / CLI flow on the Agents page in the dashboard, then pick an install method.

Replace hd_enroll_... with the token from the dashboard (shown once).

Non-interactive token

Both installers accept the token as --token or as the environment variable HOOKDEPLOYED_TOKEN:

sudo HOOKDEPLOYED_TOKEN=hd_enroll_... bash install.sh

With a token, install + enroll + start can complete unattended (suitable for servers and provisioning scripts). Without a token, the package/binary is installed and you enroll afterward — typically with the device-code flow (hookdeployed enroll), which needs a real terminal.

After install

Confirm the service is running (systemd installs):

sudo systemctl status hookdeployed

Useful next steps: CLI reference, Using taps, Production vs Development.