Webhook Relay
Search…
Docker Compose
Docker Compose is an excellent option to run multiple containers together. You can have a perfect development environment that receives webhooks directly from Stripe, Github and other services.
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.
If you don't have Docker installed, we highly recommend checking resources available on https://www.docker.com/.

Webhook forwarding

    1.
    Go to https://my.webhookrelay.com/buckets and create a bucket (we will call it β€œmy-bucketβ€œ in this example)
    2.
    Configure output destination (another container or IP address where you want to forward)
    3.
    Create a docker-compose.yaml file:
    1
    version: '3.2'
    2
    services:
    3
    relay:
    4
    container_name: webhookrelay
    5
    image: webhookrelay/webhookrelayd:latest
    6
    network_mode: host # required if you want to access other services running on localhost (otherwise localhost would be inside this container)
    7
    restart: always
    8
    environment:
    9
    # Authentication
    10
    - RELAY_KEY=${RELAY_KEY}
    11
    - RELAY_SECRET=${RELAY_SECRET}
    12
    # buckets list to subscribe
    13
    - BUCKETS=${BUCKETS}
    Copied!
    4.
    Create .env file:
    1
    ​
    2
    RELAY_KEY="your-access-token-key"
    3
    RELAY_SECRET="your-access-token-secret"
    4
    BUCKETS=my-bucket
    Copied!
    5.
    Start Docker Compose:
    1
    docker-compose up -d
    Copied!

Bidirectional tunnel

    1.
    Go to https://my.webhookrelay.com/tunnels and create a tunnel with your desired destination
    2.
    Create a docker-compose.yml file:
1
version: '3.2'
2
​
3
services:
4
relay:
5
container_name: webhookrelay
6
image: webhookrelay/webhookrelayd:latest
7
network_mode: host
8
command:
9
- --mode
10
- tunnel
11
restart: always
12
environment:
13
# Authentication
14
- RELAY_KEY=${RELAY_KEY}
15
- RELAY_SECRET=${RELAY_SECRET}
16
# One or more tunnels must be set in the .env file
17
- TUNNELS=${TUNNELS
18
- REGION=us-west # eu, au, us-west (defaults to eu)
Copied!
3. Create .env file:
1
RELAY_KEY="your-access-token-key"
2
RELAY_SECRET="your-access-token-secret"
3
TUNNELS=your-tunnel
Copied!
4. Start Docker Compose:
1
docker-compose up -d
Copied!
Last modified 2mo ago