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 and 23 built-in formatters.

→Core conceptsEndpoint security

Restrict access to your HookDeploy endpoints with IP allowlists and secret token authentication.

→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 conceptsResponse Delay

Add an artificial delay before HookDeploy responds to a webhook sender. Useful for testing timeout handling and retry logic.

→
↑↓ navigateEnter openEsc close

Roles & permissions

The complete HookDeploy permissions matrix — 5 roles and 17 permissions.

HookDeploy uses role-based access control. Each organization member has one role, and each role grants a set of permissions.

Roles

RoleKeyDescription
Super Adminsuper_adminOrganization owner — full access
AdminadminTeam management, billing, endpoints
DeveloperdeveloperCreate endpoints, replay requests
ViewerviewerRead-only access, can replay
FinancefinanceBilling management only

The org owner is always super_admin. Other members are assigned a role on invite.

Permissions

17 permissions, grouped by domain:

Organization

  • org.manage — Edit org settings (name, slug)
  • org.transfer_ownership — Transfer org to another member

Members

  • members.invite — Send invitations
  • members.remove — Remove members
  • members.change_role — Change member roles

Endpoints

  • endpoints.create — Create new endpoints
  • endpoints.edit — Edit name, description, forward URL, pause state
  • endpoints.delete — Delete endpoints and their requests
  • endpoints.view — View endpoint list and details

Requests

  • requests.replay — Replay captured requests
  • requests.delete — Delete individual requests

Billing

  • billing.view — View plan and usage
  • billing.update_payment — Update payment method via Stripe Portal
  • billing.change_plan — Upgrade, downgrade, cancel

Other

  • api_keys.manage — Create and revoke API keys
  • api_keys.manage_own — Create and revoke your own API keys
  • audit.view — View audit log

Permission matrix

Permissionsuper_adminadmindeveloperviewerfinance
org.manage✓✓
org.transfer_ownership✓
members.invite✓✓
members.remove✓✓
members.change_role✓✓
endpoints.create✓✓✓
endpoints.edit✓✓✓
endpoints.delete✓✓
endpoints.view✓✓✓✓
requests.replay✓✓✓✓
requests.delete✓✓
billing.view✓✓✓
billing.update_payment✓✓✓
billing.change_plan✓✓✓
api_keys.manage✓✓
api_keys.manage_own✓✓✓✓✓
audit.view✓✓

Role selection guide

Developer — Default for engineers integrating webhooks. Can create endpoints, inspect requests, and replay. Cannot delete endpoints, manage members, or access billing.

Viewer — For PMs, QA, or support staff who need to inspect webhook payloads and replay events but shouldn’t create or modify endpoints.

Admin — For team leads. Everything except ownership transfer. Can manage members, billing, and API keys.

Finance — For accounting or ops teams who manage the subscription but don’t need endpoint access.

Super Admin — Org owner only. One per org (the owner). Can transfer ownership.

How permissions are enforced

Dashboard and API actions require the relevant permission in the active organization. API keys are organization-scoped and operate with the creator’s effective permissions.

Checking permissions in the dashboard

Your effective permissions load on app mount alongside your organization list. If a button or action is missing, you likely lack the required permission — ask an admin to adjust your role.

Next steps