Webhook Relay
Search…
Run config.yaml reference
When running relay client as a background process, yaml configuration is used to configure forwarding
When running relay client as a background service, you will need to pre-create tunnels and forwarding configuration. The client in this mode is not creating them automatically.
To get your access key & secret, visit token page and generate one.
Minimal configuration example:
1
version: "v1"
2
key: your-secret-key # will be encrypted on startup
3
secret: your-secret # will be encrypted on startup
4
tunnels:
5
- my-spacex-tunnel
6
buckets:
7
- tesla-gigafactory-one
Copied!

Filtering based on bucket destinations (outputs)

At the moment this is not possible when running client as a background process, however this is going to be soon introduced into the relay client functionality.
To do this now, you will need to run relay agent as a Docker container with additional `DESTINATION` environment variable which could be set to:
  • `DESTINATION=my-output-name` - filter based on output name
  • `DESTINATION=my-output-id` - filter based on output ID
  • `DESTINATION=http://127.0.0.1:8123` - filter based on destination URL
​

Additional options

Additional configuration can be provided:
1
version: "v1"
2
key: your-secret-key # will be encrypted on startup
3
secret: your-secret # will be encrypted on startup
4
forwardingTransport: websocket # default is GRPC, however you can switch to WebSocket
5
serverAddress: https://my.webhookrelay.com:443
6
logs_output: /var/log/relay.log # where to write logs
7
log_level: error # debug/info/warning/error
8
tunnels:
9
- my-spacex-tunnel
10
buckets:
11
- tesla-gigafactory-one
Copied!
Last modified 1mo ago