Skip to main content
The agent is one binary, webhooktrap, for Linux, macOS and Windows on amd64 and arm64. It is open source under AGPL-3.0.
Nothing to install. The major version is pinned, so @1 always gets the newest 1.x release.

Check the install

version --json prints the version, the commit, the protocol (v1), the Go version, and the OS and architecture.

Update

The agent doesn’t update itself. Update through the channel you installed with: npm i -g @webhooktrap/agent@latest, run install.sh again, or download the new archive. npx @webhooktrap/agent@1 already takes the newest 1.x. When a server needs a newer agent, pair and agent stop with This agent (1.0.0) is too old for … ; it needs … or later.

Where the agent keeps its state

The pairing and its key live under your OS config directory, in webhooktrap/ (for example ~/.config/webhooktrap on Linux). Set WEBHOOKTRAP_CONFIG_DIR to use another directory. There is one key per server origin, written 0600 in a 0700 directory; a key readable by other users is refused. On Windows the key file’s access list isn’t checked, and the agent says so when it starts. webhooktrap test writes run documents and its confirmations under .webhooktrap/ in the current directory.