CLI Installation

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 users

curl -sSL https://storage.googleapis.com/webhookrelay/downloads/relay-linux-amd64 > relay \
&& chmod +wx relay && sudo mv relay /usr/local/bin

MacOS users

curl -sSL https://storage.googleapis.com/webhookrelay/downloads/relay-darwin-amd64 > relay \
&& chmod +wx relay && sudo mv relay /usr/local/bin

Windows

You can download the latest release from the link below:
https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe.

If you are using a 32-bit OS, use this link: https://storage.cloud.google.com/webhookrelay/downloads/relay-windows-386.exe.

Or if you have curl installed, use this command:

curl -LO https://storage.googleapis.com/webhookrelay/downloads/relay-windows-amd64.exe

Then, add the binary in to your PATH.

Linux ARM 64-bit (aarch)

curl -sSL https://storage.googleapis.com/webhookrelay/downloads/relay-linux-aarch64 > relay \
&& chmod +wx relay && sudo mv relay /usr/local/bin

Linux ARM 32-bit (armhf)

curl -sSL https://storage.googleapis.com/webhookrelay/downloads/relay-linux-arm > relay \
&& chmod +wx relay && sudo mv relay /usr/local/bin

Registration & 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:

CREATE ACCOUNTfree plan available, no credit card required

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:

Create Token

And then use it:

relay login -k token-key-here -s token-secret-here

Another option is to set environment variables:

export RELAY_KEY=token-key
export RELAY_SECRET=token-secret