Skip to main content
View source

Webhook

View as Markdown

A RocketRide source-node directory offering raw HTTP intake, browser chat and upload interfaces, and a tool-only endpoint; choose the service that matches how a client should enter the pipeline.

What it does

The directory provides four endpoint services that share a long-running, engine-provided web server: Webhook, Chat, Dropper, and Tools. Choose Webhook for programmatic HTTP intake, Chat for browser-submitted questions, Dropper for browser file uploads, or Tools when an application needs to call connected tools without adding an agent or data lane. Each service is a source, so it starts work rather than consuming a preceding pipeline lane.

Connections

Tools (tools://)

ConnectionRequiredDescription
toolnoTool nodes hosted by this endpoint through the control-plane invoke channel.

The Tools service has no data outputs. It keeps the endpoint alive so a client can reach the connected tools directly.

Lanes

Lane inLane outDescription
_sourcequestionsChat emits each browser-submitted message as a question.
_sourcetagsDropper emits uploaded files as tagged data.
_sourceTools is an invoke host and emits no data lane.
_sourcetagsWebhook can emit tagged input.
_sourcetextWebhook can emit text input.
_sourcejsonWebhook can emit JSON input.
_sourceaudioWebhook can emit audio input.
_sourcevideoWebhook can emit video input.
_sourceimageWebhook can emit image input.
_sourcequestionsWebhook can emit question input.

Configuration

These services expose no node-specific settings beyond the standard source properties. Select the service whose interaction model fits the caller, then wire its declared output lane to the downstream node that handles that data type.

Endpoint service

Use Webhook when another system can send an HTTP request, Chat when people should enter questions in a web UI, and Dropper when people should upload files in a web UI. Use Tools only to host invoke-connected tool nodes for direct client calls: it intentionally has neither a user-facing URL nor a data lane.

Authentication

On startup, Webhook, Chat, and Dropper publish an interface URL plus a public authorization key and private token in the monitor information. The Chat and Dropper button URLs include the public authorization key as the auth query parameter; Tools does not publish a user-facing URL. Treat the private token as a secret and restrict access to monitor information that contains it.

Notes

Shared server lifecycle

The endpoint registers its target with the shared web server initialized by ai.node and waits until shutdown. It does not create a server itself. If that shared server is unavailable, startup raises an explanatory error; run these services through the RocketRide pipeline process that provides it. The published interface is reachable only where deployment networking, firewalls, and reverse proxies permit access.

Schema

Chat (services.chat.json)

FieldTypeDescriptionDefault
Pipe.source.parameters

Dropper (services.dropper.json)

FieldTypeDescriptionDefault
Pipe.source.parameters

Tools (services.tools.json)

No configuration fields.

Webhook (services.webhook.json)

No configuration fields.