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

CLI reference

Verified hookdeployed subcommands and flags for enroll, connect, list, switch, unenroll, rename, and tap.

The agent CLI is Go’s flag package: help text prints single-dash names (-token, -port). Double-dash forms like --token are accepted too. Pass -h on a subcommand for the current flag set.

The binary name is hookdeployed. Examples below use that name.

enroll

Authenticate this machine to your organization and store credentials.

hookdeployed enroll
hookdeployed enroll -token hd_enroll_...
  • Device-code (interactive): prints a URL, tries to open a browser, and waits for approval. Needs a real terminal.
  • Token (scripted/CI): -token with a one-time enrollment token from the dashboard.

Common flags: -certs (cert store directory), -enroll-url (enrollment worker base URL), -no-tty (read the browser code from stdin), -client (enrollment client identifier; the Desktop Agent sets this for itself).

connect

Connect and stay connected so deliveries can arrive.

hookdeployed connect
hookdeployed connect -region us-east
  • Without -region, a relay is assigned automatically.
  • -region prefers a region and falls back unless -enforce is set.
  • -relay host or host:port pins a specific relay (default port 9443).
  • Also: -fallback a,b, -ping-interval, -certs, -enroll-url.

list

Show enrolled organizations on this machine.

hookdeployed list
hookdeployed list -json

switch

Change which enrolled organization is active. Only the active org’s traffic is delivered.

hookdeployed switch
hookdeployed switch <name-or-slug-or-id>

Interactive mode uses a TTY picker when you omit the argument.

unenroll

Remove this machine from an organization (revokes on the server unless -local-only).

hookdeployed unenroll
hookdeployed unenroll <name-or-slug-or-id>
hookdeployed unenroll -yes
hookdeployed unenroll -local-only
  • -yes skips the confirmation prompt.
  • -local-only deletes local credentials without revoking the agent server-side.

rename

Set the agent’s display name for the active organization.

hookdeployed rename -name "staging-box"
hookdeployed rename staging-box

-name with an empty value clears the display name back to the hostname fallback.

tap

Temporarily mirror live endpoint or destination traffic to a local port and path. See Using taps.

hookdeployed tap <endpoint-id> [<destination-id>] -port 3000 -path /hooks
hookdeployed tap <endpoint-id> -port 3000 -path /hooks -duration 2h
hookdeployed tap list
hookdeployed tap list -json
hookdeployed tap stop
hookdeployed tap stop <tap-id>
  • -port and -path are required to start a tap (-path must start with /).
  • -duration is a Go duration (for example 2h). The server clamps at 8 hours.
  • Omitting destination id taps the endpoint (raw). With a destination id, you get destination-shaped traffic.
  • Starting a tap blocks in a terminal until Ctrl+C (or use -no-tty for headless stop-on-stdin-close). tap stop ends a tap early.