Install

How to install Webhook Relay CLI client

Web Relay provides an official command client for quick configuration of webhook forwarding, tunnels and can also provision authentication tokens. It provides batteries-included agent for developing and testing workflows. It takes only a few seconds for it to start running with one-way HTTP request forwarding, bidirectional tunnels, and CLI for managing your resources.

Download & Install

Linux and MacOS users

Run the following script to download and setup the relay CLI:

curl https://my.webhookrelay.com/webhookrelay/downloads/install-cli.sh | bash

Windows

iwr https://my.webhookrelay.com/webhookrelay/downloads/install-cli.ps1 -useb | iex

FreeBSD

Download the binary:

# For amd64
sudo fetch -o /usr/local/bin/relay https://storage.cloud.google.com/webhookrelay/downloads/relay-freebsd-amd64

# For i386
sudo fetch -o /usr/local/bin/relay https://storage.cloud.google.com/webhookrelay/downloads/relay-freebsd-386

Give it permissions to execute and update itself:

sudo chmod +wx /usr/local/bin/relay

Authentication

In order to start using the service, you will need to create an account. If you already have an account, skip this section. Head to the registration page https://my.webhookrelay.com/register and register.

Relay CLI needs credentials for your account. Once registered, generate a token and use token key and secret as a username and password for CLI authentication and follow the instructions to use it in your terminal:

Create Token

Download binaries directly

If you wish to skip using our installation script, you can find individual executables here:

# Linux x86-64 (64-bit)
https://storage.googleapis.com/webhookrelay/downloads/relay-linux-amd64

# Linux x86 (32-bit)
https://storage.googleapis.com/webhookrelay/downloads/relay-linux-386

# Linux aarch (64-bit)
https://storage.googleapis.com/webhookrelay/downloads/relay-linux-aarch64

# Linux arm (32-bit)
https://storage.googleapis.com/webhookrelay/downloads/relay-linux-arm

# Windows (64-bit)
https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe

# Windows (32-bit)
https://storage.googleapis.com/webhookrelay/downloads/relay-windows-386.exe