Webhook Relay
Search…
Introduction
Quick Start - Forwarding
Quick Start - Tunnels
🛠
Installation
Relay CLI
Containerized
Kubernetes Installation
Podman
Docker
Docker Compose
Products
🛰
Webhook Forwarding
⚡
Functions
🔃
Tunnels
📝
Examples
Intro to examples
Webhooks
Functions
Tunnels
🏠
Home Automation
Platform
CLI Basics
Using CLI Behind Proxy
Self-hosting Server
Security & Tech
Powered By GitBook
Docker
Docker is the most popular way to run Webhook Relay agent to forward webhooks and open tunnels.
Webhook Relay 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/.

Forward webhooks

  1. 1.
    Go to https://my.webhookrelay.com/buckets and create a bucket
  2. 2.
    Configure output destination (another container or IP address where you want to forward)
  3. 3.
    Go to https://my.webhookrelay.com/tokens and get your access key and secret
  4. 4.
    Start the agent:
1
docker run webhookrelay/webhookrelayd \
2
-k [access key] \
3
-s [access secret] \
4
-b my-bucket-name
Copied!
You can also specify configuration through environment variables:
1
KEY=<your token key>
2
SECRET=<your token secret>
3
BUCKET=<bucket filter>
Copied!
If you are using self-signed certificates on your internal side, specify INSECURE environment variable to skip validation:
1
INSECURE=true
Copied!
If you are behind a VPN or a firewall that doesn't allow egress gRPC traffic to my.webhookrelay.com:8080, then add environment variable to use WebSocket transport:
1
WEBSOCKET_TRANSPORT=true
Copied!

Open a tunnel

  1. 1.
    Go to https://my.webhookrelay.com/tunnels and create a tunnel with your desired destination
  2. 2.
    Go to https://my.webhookrelay.com/tokens and get your access key and secret
  3. 3.
    Start a tunnel:
1
docker run --name whr-relayd \
2
--net host \
3
--restart always \
4
-d webhookrelay/webhookrelayd:latest \
5
--mode tunnel -t mytunnelname -k [access key] -s [access secret]
Copied!
Here webhookrelayd commands:
  • –mode tunnel indicates that it should start bidirectional tunnel
  • -t mytunnelname acts as a filter, it has to match the tunnel name that you have created previously
  • -k [access key] is your authentication token key
  • -s [access secret] is your authentication token secret
You can also specify these details through environment variables:
1
KEY=<your token key>
2
SECRET=<your token secret>
3
TUNNELS=<comma separated list of tunnels>
4
REGION=<region - eu, au, us-west (defaults to eu)>
Copied!
Previous
Podman
Next
Docker Compose
Last modified 1mo ago
Copy link
Contents
Forward webhooks
Open a tunnel