Webhook Relay
PricingLogin
  • Introduction
  • Quick Start - Forwarding
  • Quick Start - Tunnels
  • πŸ› οΈInstallation
    • Relay CLI
      • Install
      • Auto-start
      • Run config.yaml reference
    • Containerized
      • Kubernetes Installation
      • Podman
      • Docker
      • Docker Compose
  • Products
    • πŸ›°οΈWebhook Forwarding
      • Glossary
      • WebSocket Server
      • Authentication
      • Custom Domains
    • ⚑Functions
      • Managing functions
      • Edit request/response
      • Working with JSON
      • 🦾Advanced
        • Working with time
        • Testing functions in CLI
        • Making HTTP Requests
        • Multipart Form Data
        • URLEncoded Form Data
        • GCP BigQuery
        • Sending Emails
        • JWT authentication
        • Base64, Hashes, Encryption
      • πŸ€–Integrating into CI/CD
    • πŸ”ƒTunnels
      • Using tunnels
      • Custom Domains
      • Encryption (HTTPS)
      • Regions
  • πŸ“Examples
    • Intro to examples
    • Webhooks
      • Receiving webhooks on localhost
      • Receive webhooks inside your JavaScript app
      • Execute shell scripts on remote machines
    • Functions
      • Enrich webhooks from 3rd party APIs
      • Convert DockerHub webhook to Slack notification
      • Allowing only POST requests through
      • Manipulate webhook request body
    • Tunnels
      • Ingress for any Kubernetes environment
      • Demoing your website
    • 🏠Home Automation
      • Home Assistant
      • Node-RED
      • Raspberry Pi
  • Platform
    • CLI Basics
    • Using CLI Behind Proxy
    • Self-hosting Server
      • Server deployment
      • Client configuration
    • Security & Tech
Powered by GitBook
On this page
  • Forward webhooks
  • Open a tunnel

Was this helpful?

  1. Installation
  2. Containerized

Docker

Docker is the most popular way to run Webhook Relay agent to forward webhooks and open tunnels.

PreviousPodmanNextDocker Compose

Last updated 11 months ago

Was this helpful?

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. Go to and create a bucket

  2. Configure output destination (another container or IP address where you want to forward)

  3. Go to and get your access key and secret

  4. Start the agent:

docker run --network host -d webhookrelay/webhookrelayd \
  -k [access key] \
  -s [access secret] \
  -b my-bucket-name

You can also specify configuration through environment variables:

KEY=<your token key>
SECRET=<your token secret>
BUCKETS=<bucket filter>
DESTINATION=<destination output ID, name or URL to filter on>

If you are using self-signed certificates on your internal side, specify INSECURE environment variable to skip validation:

INSECURE=true

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:

WEBSOCKET_TRANSPORT=true

Open a tunnel

  1. Start a tunnel:

docker run --name whr-relayd \
  --net host \
  --restart always \
  -d webhookrelay/webhookrelayd:latest \
  --mode tunnel -t mytunnelname -k [access key] -s [access secret]

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:

KEY=<your token key>
SECRET=<your token secret>
TUNNELS=<comma separated list of tunnels>
REGION=<region - eu, au, us-west (defaults to eu)>

Go to and create a tunnel with your desired destination

Go to and get your access key and secret

πŸ› οΈ
https://my.webhookrelay.com/buckets
https://my.webhookrelay.com/tokens
https://my.webhookrelay.com/tunnels
https://my.webhookrelay.com/tokens