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:
- CLI - allows you to forward webhooks, open tunnels from your computer and manage pretty much anything that you can do through the web UI.
- Docker container - allows you to forward webhooks or open a tunnel through our container. Typically used in production applications. Can also be used from within Kubernetes.
- Kubernetes ingress controller - should be used within your Kubernetes cluster.
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 CLIto see alternative methods, please continue
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/.
- Go to https://my.webhookrelay.com/buckets and create a bucket
- Configure output destination (another container or IP address where you want to forward)
- Start a webhookrelayd agent:
- Go to https://my.webhookrelay.com/tunnels and create a tunnel with your desired destination
- Start a bidirectional tunnel:
Webhook Relay can help you receive webhooks in your internal services. To achieve that you can either use sidecar approach or a standalone deployment. Since container is stateless and only requires your access key & secret, deploying and running it is extremely easy.
First, go to https://my.webhookrelay.com/tokens and create a token key & secret pair. Then, create a Kubernetes secret:
Once the secret is created, you can deploy webhookrelayd container either as a sidecar or a standalone container.
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.