Quick Start (Forwarding)
Webhook Relay provides public endpoints which can accept webhooks 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 are configurable and can return custom responses, outputs on the other hand, can have filtering rules and forward webhooks to both internal or public destinations:
Using configuration helpers (recommended)
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.
A newly created bucket will have a default input and you will need to create an output destination.
To do that, click on OUTPUT DESTINATIONS. If it’s a public destination, add the name, HTTP URL and click ‘create output’. All received webhooks will be forwarded to that destination.
If it’s an internal destination, check ‘internal network’ and start a
$ relay forward --bucket new http://localhost:8080 Forwarding: https://vlndyzsibcil98gdte7l3r.hooks.webhookrelay.com -> http://localhost:8080
What can be forwarded?
Currently Webhook Relay forwards:
- Body (up to 3MB)
- URL query, for example
https://xyz.hooks.webhookrelay.com?foo=bar, will be forwarded to
- Extra path that’s after your public input endpoints:
https://xyz.hooks.webhookrelay.com/directory/foowill be forwarded to
Functions, when applied on Inputs can provide dynamic response. See functions documentation.
If you would like to learn more about other features such as rules matching, utilizing custom domains and functions, go to the deep-dive section.