Skip to content

Documentation

Docs

From install to a delivered event, then how to run hooks day to day. Hooks are never edited in the browser: use the CLI or an MCP agent.

Quickstart

Four commands from nothing to a URL that receives webhooks.

terminal
curl -fsSL https://hooksmith.tech/install.sh | bash
hooksmith login
hooksmith init && hooksmith new my-first-hook
hooksmith deploy my-first-hook

Documentation pages

Each page covers one part of the workflow. Start with install if you have not used the CLI yet.

  • Install and sign in

    Install the CLI and connect it to your account with a device code or a token.

    Install · Connect account

  • Create and edit hooks

    The TUI and agent, conditions and @headers, the MCP tools and quiet hours.

    Create a hook · Conditions and headers · Agent / MCP · Quiet hours

  • Secrets and sender verification

    Write-only secrets, signature verification and the eight provider presets.

    Secrets · Verify the sender · Providers

  • Deploy and operate

    Deploy a hook, watch and replay events, failure alerts and deleting hooks.

    Deploy · Operate · Failure alerts

  • Desktop app

    The macOS menu bar app: localhost tunnel, editor, alerts and updates.

    Desktop app

  • Team, plans and limits

    Invites and roles, delivery behavior, retries, retention and plan limits.

    Team and invites · Behavior and limits