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
  • What is webhook forwarding?
  • Inputs
  • Outputs
  • Buckets
  • Tunnels
  • Access tokens

Was this helpful?

Introduction

NextQuick Start - Forwarding

Last updated 3 years ago

Was this helpful?

Webhook Relay is an API driven, secure tunnelling solution. Our two main services are:

  • - secure, unidirectional by default with optional request/response transformation.

  • - fast tunnels for direct access to any HTTP service. This is ideal for accessing internal services and demoing websites.

What is webhook forwarding?

Webhook forwarding is by default a uni-directional (β€œone way”) way to send webhooks to other internal and public destinations.

Key facts:

  • Unidirectional by default, but you can enable it to wait for the response.

  • Single received webhook can be forwarded to multiple destinations.

You can use webhook forwarding when:

  • Your requirement is primarily β€œfire and forgetβ€œ.

  • You need to forward a single webhook to multiple destinations (fan-out).

  • You need to transform webhook, for example Docker push webhook into a Slack message.

Inputs

  • Domain name (configurable in all paid plans).

  • Static response code, headers and body.

  • Dynamic response coming from any destination (must respond within 10 seconds).

Outputs

Main options for output configuration:

  • Destination (where to forward).

  • Path lock - whether to dynamically append URL paths (xyz.hooks.webhookrelay.com/foo/bar -> localhost:8080/foo/bar)

Buckets

Tunnels

Tunnels can be used to open bidirectional pathways that allow remote access to the server.

Access tokens

You can use to filter and modify requests/responses.

You need to forward webhooks to internal destinations ().

Inputs represent your public endpoints. These are the unique for instance, https://xyz.hooks.webhookrelay.com. Each input have several configuration options:

Each input can have an attached which can modify response and request.

Outputs define your destination, where webhooks will be sent. These destinations can either be an HTTP server running on your local machine () or a public server such as .

Attached to execute on a webhook.

are a grouping mechanism in Webhook Relay for Inputs and Outputs.

Webhook Relay tunnels

You can create, view and manage your tunnels here: .

Access tokens are used to authenticate Webhook Relay agents and any other API requests. You can provision a key and secret pair here: .

Functions
quick start here
URLs
function
http://localhost:8080
https://example.com
function
Buckets
https://my.webhookrelay.com/tunnels
https://my.webhookrelay.com/tokens
Webhook Forwarding
Bidirectional Tunnelling