Webhook Relay
PricingLogin
  • Introduction
  • Quick Start - Forwarding
  • Quick Start - Tunnels
  • 🛠️Installation
    • Relay CLI
      • Install
      • Auto-start
      • Run config.yaml reference
    • Containerized
      • Kubernetes Installation
      • Podman
      • Docker
      • Docker Compose
  • Products
    • 🛰️Webhook Forwarding
      • Glossary
      • WebSocket Server
      • Authentication
      • Custom Domains
    • ⚡Functions
      • Managing functions
      • Edit request/response
      • Working with JSON
      • 🦾Advanced
        • Working with time
        • Testing functions in CLI
        • Making HTTP Requests
        • Multipart Form Data
        • URLEncoded Form Data
        • GCP BigQuery
        • Sending Emails
        • JWT authentication
        • Base64, Hashes, Encryption
      • 🤖Integrating into CI/CD
    • 🔃Tunnels
      • Using tunnels
      • Custom Domains
      • Encryption (HTTPS)
      • Regions
  • 📝Examples
    • Intro to examples
    • Webhooks
      • Receiving webhooks on localhost
      • Receive webhooks inside your JavaScript app
      • Execute shell scripts on remote machines
    • Functions
      • Enrich webhooks from 3rd party APIs
      • Convert DockerHub webhook to Slack notification
      • Allowing only POST requests through
      • Manipulate webhook request body
    • Tunnels
      • Ingress for any Kubernetes environment
      • Demoing your website
    • 🏠Home Automation
      • Home Assistant
      • Node-RED
      • Raspberry Pi
  • Platform
    • CLI Basics
    • Using CLI Behind Proxy
    • Self-hosting Server
      • Server deployment
      • Client configuration
    • Security & Tech
Powered by GitBook
On this page
  • Option A: Using configuration helpers
  • Option B: Configuring manually
  • What can be forwarded?
  • Learn more

Was this helpful?

Quick Start - Forwarding

How to send webhooks to private or public destinations

PreviousIntroductionNextQuick Start - Tunnels

Last updated 2 years ago

Was this helpful?

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:

Option B: Configuring manually

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:

relay forward --bucket jenkins

Example output:

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

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

Learn more

- 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 .

https://my.webhookrelay.com/new-basic-forwarding
https://my.webhookrelay.com/new-forwarding
buckets page
here
functions documentation
deep-dive section
Newly created bucket
Create an output
creating a new output