Quick Start - Forwarding
How to send webhooks to private or public destinations
Last updated
Was this helpful?
How to send webhooks to private or public destinations
Last updated
Was this helpful?
Webhook Relay provides public endpoints which can accept HTTP requests and then forward them to either public or internal destinations.
Based on your needs, there are multiple different ways to start forwarding. The easiest one for internal destinations is using the relay CLI directly.
Installing the CLI:
Then, to forward webhooks to https://localhost:8080/webhooks by running:
We have a step-by-step configuration wizards that will help you:
A newly created bucket will have a default input. However, you will need to create an output destination.
To do that, click on Add More in the "Output Destinations" section:
Set name, destination and output type, then click ‘create’:
All received webhooks will be forwarded to that destination. If you selected 'internal' network, you will need to start the relay agent as well:
Example output:
Currently Webhook Relay forwards:
Body (up to 2MB for regular buckets and up to 50MB when Large Webhooks are enabled)
Headers
URL query, for example https://xyz.hooks.webhookrelay.com?foo=bar
, will be forwarded to http://localhost:8080?foo=bar
Extra path that’s after your public input endpoints: https://xyz.hooks.webhookrelay.com/directory/foo
will be forwarded to http://localhost:8080/directory/foo
- simple single input and single output to internal or public destination
- for more advanced use-cases when request transformation is required
Once configuration is created, you can always edit all details by visiting your . If your destination is internal, you will need to start the agent.
Relay CLI installation instructions can be found .
Functions, when applied on Inputs can provide dynamic response. See .
If you would like to learn more about other features such as rules matching, utilising custom domains and functions, go to the .