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
  • Usage
  • Installing node-red-contrib-webhookrelay node
  • Creating Webhook Relay bucket
  • Getting token key & secret
  • Configuring node-red-contrib-webhookrelay node

Was this helpful?

  1. Examples
  2. Home Automation

Node-RED

PreviousHome AssistantNextRaspberry Pi

Last updated 3 years ago

Was this helpful?

We provide node that can be used with Node-RED to easily received webhooks.

Usage

To use this node, some configuration is required:

  1. Install node-red-contrib-webhookrelay

  2. Create bucket at

  3. Generate tokens at

  4. Supply bucket and token key & secret into the node

Detailed steps with screenshots are available below.

Installing node-red-contrib-webhookrelay node

Open โ€˜paletteโ€™ on your Node-RED web interface and install node-red-contrib-webhookrelay node:

install node-red-contrib-webhookrelay node

Creating Webhook Relay bucket

Buckets are like groups where you can have multiple input URLs and multiple outputs. Create at least one output to receive webhooks over WebSocket connection (Node-RED uses it under the hood) then you will be able to resend webhooks manually (good for testing integrations).

Getting token key & secret

Configuring node-red-contrib-webhookrelay node

Add bucket name and your token key & secret into the node:

Go to your and create a bucket called nodered and at least one internal output (destination doesnโ€™t matter):

bucket created

Retrieve token key & secret from page. While token key will remain visible, secret is already encrypted and cannot be decrypted. If you lose your secret, just delete the token and create a new one.

๐Ÿ“
๐Ÿ 
buckets page
https://my.webhookrelay.com/tokens
node-red-contrib-webhookrelay
https://my.webhookrelay.com/buckets
https://my.webhookrelay.com/tokens