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
  • Input endpoint authentication
  • Basic authentication
  • Bearer (token) authentication

Was this helpful?

  1. Products
  2. Webhook Forwarding

Authentication

Webhook Relay supports authentication on public endpoints and can also send authentication details to the destinations.

PreviousWebSocket ServerNextCustom Domains

Last updated 3 years ago

Was this helpful?

Input endpoint authentication

By default webhook endpoints accept incoming requests without authentication. To enable authentication on all public endpoints that belong to a bucket, go to the authentication section:

Then, you can either select "basic" or "token" authentication methods.

Basic authentication

With basic authentication you will need to specify username and password. Unauthenticated requests to bucket's inputs will result in "Unauthorized" error:

curl https://hqzxx4bpayrk4sdrfifte6.hooks.webhookrelay.com
Unauthorized

The endpoint now expects a request to have 'Authorization: Basic <base64 encoded username:password>' header. Tools like curl can help authenticate:

curl \
  --user test-username:test-password \
  https://hqzxx4bpayrk4sdrfifte6.hooks.webhookrelay.com

Bearer (token) authentication

To use bearer token authentication, select 'token' from the authentication menu and set your token value. In this case, to successfully send webhooks, you will need to set 'Authorization: Bearer <your token>' header:

curl \ 
  -H 'Authorization: Bearer very-secret' \
  https://hqzxx4bpayrk4sdrfifte6.hooks.webhookrelay.com

🛰️
bucket authentication settings