Web Relay (also known as Webhook Relay) is a tunneling service for creating reverse tunnels for one-way or bidirectional data transfer to internal services (running on your laptop, an internal JIRA/Bitbucket server in your private network). Web Relay is designed to be easy-t-start-with and remain flexible enough for advanced use cases. The core webhookrelayd agent uses a combination of GRPC protocol based service and raw encrypted TCP connections for performance. Web Relay is perfectly capable of powering sophisticated use cases where performance and dynamic routing configuration is required.
The official guide assumes beginner level knowledge of terminal, networks and web applications.
The easiest way to try out Web Relay is by using the
relay command client..
The Installation page provides more options of installing the CLI. Please note, that we do recommend that beginners start with
relay, especially if they are not yet familiar with daemons or Docker.
CREATE ACCOUNTfree plan available, no credit card required
Relay CLI was modeled against Docker’s CLI so command structure should be familiar.
To list available commands, use help:
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. If you have standard username/password account, you can use same credentials. If you are using OAuth to authenticate, generate a token.
Another option is to set environment variables:
At the core of Web Relay is a webhook delivery system that enables one-way HTTP request forwarding to the destination. Once webhook is accepted, it will be forwarded to all outputs listed in the bucket. To start forwarding:
We have already created our very first configuration for webhook forwarding! Any request that hits
https://my.webhookrelay.com/v1/webhooks/5e722a5e-f3d2-4hqec-9e9f-79f1158e4b10 endpoint will be forwarded to locally running application reachable on
http://localhost:8090/webhook address. Headers, method and body will be preserved.
Another core feature of Web Relay are bidirectional tunnels that allow traffic to go both ways. If we want to connect to the same application reachable locally on http://localhost:8090 address, then use connect command:
That’s it! A new personal subdomain will be generated and you can access your locally running service through the public endpoint here. In this example the generated host is
Please note that custom subdomains are also available.
We’ve briefly introduced the most basic features of Web Relay - the rest of this guide will cover them as well as other advanced features with much finer details. Please make sure to read through it all!