HookDeploy field manual
From first payload
to production route.
Find the exact control, API route, or operating rule you need—without digging through implementation details.
Customer-facing reference28 guidesREST API + integrations
Webhook path
Follow the signal.
01Capture
Receive your first webhook
Create an endpoint, send a real payload, and inspect what arrived.
02Protect
Set the trust boundary
Add tokens, IP rules, sanitization, and understand encrypted storage.
03Deliver
Route it where it belongs
Forward, transform, retry, or deliver privately with the HookDeploy Agent dialing out over mTLS.
04Operate
Automate the workflow
Use the REST API, roles, usage reporting, and organization controls.
Start here
Capture a real webhook in five minutes.
No local server required. The Free plan is enough.Open Quickstart →$ curl -X POST https://hookdeploy.dev/h/YOUR_16_CHAR_SLUG \
-H "Content-Type: application/json" \
-d '{"event":"payment.succeeded"}'
{"request_id":"req_..."}Reference directory
Browse by system.
ForwardingForward captured webhooks to one or more destinations, with optional payload transformation.→TransformationsReshape webhook payloads before forwarding with the visual editor, 35 built-in formatters, conditions, and form-encoded support.→Privacy filtersReshape or redact webhook payloads before HookDeploy stores them ΓÇö without changing what forward destinations receive.→Custom ResponsesOverride the HTTP response HookDeploy returns to webhook senders. Set a custom status code, response body, and dynamic variables for testing and mocking.→Endpoint securityRestrict access to your HookDeploy endpoints with IP allowlists and secret token authentication.→Response DelayAdd an artificial delay before HookDeploy responds to a webhook sender. Useful for testing timeout handling and retry logic.→Platform VerificationAutomatically handle webhook verification handshakes from Meta, Slack, and Zoom so your endpoint registers without extra configuration.→IncidentsCorrelate forward failures into incidents, triage with status and updates, and bulk-replay failed deliveries at a controlled rate.→EndpointsWhat endpoints are, how slugs work, pausing, and configuring a forward URL.→RequestsWhat HookDeploy captures for each webhook — headers, body, query, IP — plus retention and payload limits.→ReplayManually re-send captured webhooks to any HTTPS URL, with replay history and API support.→OrganizationsHow organizations, members, roles, and personal vs team orgs work in HookDeploy.→Private DeliveryDeliver captured webhooks to private services with the HookDeploy Agent dialing out over mTLS, without exposing a handler to the public internet.→Cron jobsSchedule HTTP requests to any HTTPS URL on a recurring cadence with timezone-aware scheduling, run history, and failure notifications.→
OverviewWhat the HookDeploy CLI and Desktop Agent are, how they relate, and when to use each.→Install the CLIInstall hookdeployed on Linux with the APT repo or the GitHub install script, including non-interactive enrollment.→Install the Desktop AgentDownload and install the HookDeploy Desktop Agent on Windows and macOS, including SmartScreen and first-launch notes.→CLI referenceVerified hookdeployed subcommands and flags for enroll, connect, list, switch, unenroll, rename, and tap.→Using tapsTemporary local mirroring of live webhook traffic from the CLI or Desktop Agent.→Production vs DevelopmentHow agent environments affect retries, offline expectations, and plan limits.→
API OverviewAuthentication, response conventions, current routes, errors, and pagination for the HookDeploy REST API.→Endpoints APICreate, read, update, and delete webhook endpoints via the REST API.→Requests APIList and retrieve captured webhook requests with full decrypted payload, headers, query params, and forwarding results.→Destinations APIManage saved HTTPS destinations in your organization library, create agent forward destinations on endpoints, and list forward destinations configured on a webhook endpoint.→Replay APIRe-send a captured webhook to any HTTPS target URL via the REST API.→Incidents APIList and inspect correlated forward-failure incidents, update status, and queue paced bulk replay.→Members APIManage organization members programmatically — invite, deactivate, and reactivate members via the HookDeploy REST API.→Usage APIRetrieve current month usage and plan limits for your organization.→Incident subscriptionsSubscribe to incident lifecycle events with REST Hooks — created, investigating, resolved, and update added.→
Integration guides