For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CommunitySign Up
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
    • SDKs
    • WebRTC SDK
    • WebRTC Web Guide
    • WebRTC React Native Guide
    • WebRTC API Reference
    • Node.js SDK
    • Python SDK
    • Node-RED
    • nodeclient
    • nodeclientws
LogoLogo
CommunitySign Up

Node-RED

Was this page helpful?
Edit this page
Previous

Node.JS SDK

Next
Built with

To add the jambonz plugins for Node-RED open Node-RED, click the hamburger menu at the top right, and then “Open Palette”.

Click the “install” tab and then type “jambonz” into the search input.

Adding jambonz plugin

Click the “Install” button for @jambonz/node-red-contrib-jambonz, and confirm by clicking the Install button on the popup dialog.

This will add the jambonz nodes to your palette. Now you can drag them out onto the canvas to create flows that respond to webhook requests. Every flow should begin with a “webhook in” node and end with a “webhook out” node.

Node-RED flow

Configure the webhook in node by specifying the URL path and HTTP method that should trigger this flow.

Node-RED webhook-in

There is no configuration needed for the webhook out node.

Most of the remaining nodes match up one to one to the jambonz verbs. Drag them out on the canvas, configure them and connect them in the ordered flow you want to achieve.

Node-RED webhook-say

When you are done, click the Deploy button to deploy your changes. In the jambonz portal, create an application webhook with a URL and path that points to your Node-RED server and the flow that you have created.

Enjoy!