Step 1: Download the client

First, download the relay client, a lightweight binary with no dependencies.

Linux (64-bit) Mac OS Windows Windows (32-bit) ARM

Once downloaded, rename it to just 'relay' (or 'relay.exe' if you are using Windows OS). It's also a good practice to create an alias or place it in your PATH for easier access.

Alternative installation methods:


Step 2: Authenticate to your account

In order to use the client, you will need to authenticate through key & secrect pair. If you don't have an account, please register first. Get your token:

CREATE ACCOUNT (free tier available)

GENERATE TOKEN

Once you have your token, supply it to the client:

./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

Step 3: Connect

Webhook Relay provides flexible ways to configure your webhook forwarding and tunneling, you can find detailed instructions in our documentation documentation. However, for most uses cases only two commands should be enough:

  • connect - bidirectional tunnel, perfect for demoing websites, testing backend services
  • forward - secure one-way forwarding, ideal for webhooks