Quick Start - Forwarding
How to start using Webhook Relay to forward webhooks
Webhook Relay provides public endpoints which can accept HTTP requests and then, based on user defined rules, forward them to either public or internal destinations.
Our service has a concept of bucket which is basically a grouping mechanism that enables you to accept webhooks on multiple endpoints and forward them to one or more destinations. Bucket inputs can be customised with dynamic responses and outputs can be configured to perform filtering and forward webhooks to both internal or public destinations:

Webhook routing
Based on your needs, there are multiple different ways to start forwarding. The easiest one for internal destinations is using the relay CLI directly:
relay forward -b my-bucket https://localhost:8080/webhooks
We have a step-by-step configuration wizards that will help you:
- https://my.webhookrelay.com/new-basic-forwarding - simple single input and single output to internal or public destination
- https://my.webhookrelay.com/new-forwarding - for more advanced use-cases when request transformation is required
Once configuration is created, you can always edit all details by visiting your buckets page. If your destination is internal, you will need to start the agent.
A newly created bucket will have a default input. However, you will need to create an output destination.

Newly created bucket
To do that, click on Add More in the "Output Destinations" section:

Create an output
Set name, destination and output type, then click ‘create’:

creating a new output
All received webhooks will be forwarded to that destination. If you selected 'internal' network, you will need to start the relay agent as well:
relay forward --bucket new-bucket
Example output:
relay forward --bucket new-bucket
Forwarding:
https://vlndyzsibcil98gdte7l3r.hooks.webhookrelay.com -> https://192.168.1.100:8080/github-webhooks
Currently Webhook Relay forwards:
- Body (up to 3MB)
- Headers
- URL query, for example
https://xyz.hooks.webhookrelay.com?foo=bar
, will be forwarded tohttp://localhost:8080?foo=bar
- Extra path that’s after your public input endpoints:
https://xyz.hooks.webhookrelay.com/directory/foo
will be forwarded tohttp://localhost:8080/directory/foo
If you would like to learn more about other features such as rules matching, utilising custom domains and functions, go to the deep-dive section.
Last modified 1yr ago