HOME/DOCS/QUICKSTART

Quickstart

Install sendword and trigger your first hook in five minutes.

Get sendword running and trigger your first hook in five minutes.

Install

Install from crates.io if you already have a Rust toolchain:

cargo install sendword

Or install the latest Linux x86_64 binary:

curl --proto '=https' --tlsv1.2 -LsSf https://releases.sendword.online/latest/sendword-installer.sh | sh

Windows users can use PowerShell:

powershell -ExecutionPolicy Bypass -c "irm https://releases.sendword.online/latest/sendword-installer.ps1 | iex"

Or start the container image:

mkdir -p data
docker run --rm -p 8080:8080 -v "$PWD/data:/data" ghcr.io/wavefunk/sendword:latest

Create a configuration

Create a sendword.toml file:

[server]
bind = "127.0.0.1"
port = 8080

[[hooks]]
name = "Hello World"
slug = "hello"

[hooks.executor]
type = "shell"
command = "echo 'hello from sendword'"

Start the server

sendword serve

The web UI is now available at http://localhost:8080. Your hook is ready to receive webhooks at POST /hook/hello.

Trigger your hook

curl -X POST http://localhost:8080/hook/hello

Check the dashboard to see the execution result, stdout, and stderr.

Next steps