Relay agent runs on Linux, Windows and MacOS distributions. If you require support for a different architecture, please contact support at [email protected].
There are several supported tools, please choose what best suits your needs:
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:
Once you have CLI downloaded, use it:
Another option is to set environment variables:
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.
Mac users can install client through homebrew:
You can download the latest release from the link below:
Or if you have curl installed, use this command:
Add the binary in to your PATH.
You can download binaries from here. These are self contained applications, no dependencies required.
Webhookrelayd agent can either forward requests to destinations or open bidirectional tunnels. It is a single Docker image that requires access key and secrets for authentication.
This image can be used either in a single machine or in cluster schedulers such as Kubernetes.
If you don’t have Docker installed, we highly recommend checking resources available on https://www.docker.com/.
To start a webhookrelayd agent:
Webhookrelayd agent can be easily deployed as a sidecar.
This way requests can be forwarded to the service through localhost:
If agent is deployed as a separate deployment, the output destination should then be a service name.
Repository can be found here: https://github.com/webhookrelay/webhook-demo.
If you are using Kubernetes, you should also check out ingress controller.
Bucket: a simple way to group two primary resources; inputs and outputs. Every incoming webhook that goes into any input inside a bucket will be relayed to all outputs defined in the same bucket.
Input: an entry point into Webhook Relay service. Input is your unique personal inbox which is tied to your account.
Output: a destination where Webhook Relay should route requests. Outputs can be either internal or public. Public outputs are being handled by the Webhook Relay service itself while internal outputs will be delegated to user agents.
Tunnel: a bidirectional HTTP tunnel between webrelay.io public endpoint and user supplied destination.
Access Token: a pair of key and secret to authenticate to Web Relay services. Users can provision access tokens to safely use in daemons or CLI.