Quick Start - Forwarding

How to send webhooks to private or public destinations

Webhook Relay provides public endpoints which can accept HTTP requests and then forward them to either public or internal destinations.

Webhook routing to public and private

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:

curl https://my.webhookrelay.com/webhookrelay/downloads/install-cli.sh | bash

Then, to forward webhooks to https://localhost:8080/webhooks by running:

relay forward -b my-bucket https://localhost:8080/webhooks

Option A: Using configuration helpers

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.

Option B: Configuring manually

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 jenkins

Example output:

relay forward --bucket jenkins
Forwarding: 
https://vlndyzsibcil98gdte7l3r.hooks.webhookrelay.com -> https://192.168.1.100:8080/github-webhooks

Relay CLI installation instructions can be found here.

What can be forwarded?

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

Functions, when applied on Inputs can provide dynamic response. See functions documentation.

Learn more

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.