HTTP Webhook Trigger

The edge gateway for API-driven workflows. Exposes standard HTTP endpoints, authenticates incoming requests, extracts correlation identities, and releases normalized payloads into visual canvas nodes.

Spec v1.1 RESTful Entry

Port Overview

No input ports
Entry point node — triggered by external HTTP requests only.
HttpWebhook Trigger
Trigger
Output ports
onTrigger

Node Properties

Configuration settings set in the UI panel. During deployment, the WBSKT engine hoists these parameters to the Webhook Router for native, high-performance edge execution.

HttpWebhookTrigger

Endpoint & Routing

Property Type Default Description
path string required The relative URL path (e.g., /v1/github/merge). Must be unique within the tenant.
method enum POST POST | GET | PUT | DELETE
correlationExpression expression null A JSONPath or regex to extract a unique Instance Context ID (e.g., $.body.order_id).
onMatch enum MapOrCreate MapOrCreate(Genesis) Creates a new instance if the resolved ID is unknown. Updates if known.
MapOrDiscard(Signal) Only updates existing instances. If no match is found, the signal is dropped.
AlwaysCreate — Ignores the resolved ID and spawns a parallel instance (useful for stateless logs).
MapOrReplace — Aborts the existing instance and starts a fresh one with the new payload.

Authentication & Gatekeeping

Property Type Default Description
authType enum None None — Public endpoint.
ApiKey — Header validation (e.g., X-API-Key).
BasicAuth — Native username and password decoding.
HMAC — Cryptographic signature hashing (Best for Stripe/GitHub).
secretRef string null Pointer to a securely stored secret vault reference used for validating incoming tokens.

Response Handling

Property Type Default Description
responseMode enum AckOnArrival AckOnArrival — Responds 202 Accepted immediately. Does not wait for workflow execution.
RespondOnComplete — Freezes HTTP connection and returns a snapshot of the WorkflowContext when execution halts.
successCode int 200 Status code returned to the external platform upon successful webhook acceptance.
Shared State Architecture Connections between nodes do not carry data payloads. Wires only transmit pure triggers (pulses). When a Webhook fires, it writes the payload directly into the WorkflowContext. Downstream nodes pull variables from this shared memory as needed.

Port Detail

Once data clears authentication and engine mapping, it is committed to the instance context and releases a control signal to begin execution.

Output ports
onTrigger signal
Fires a control pulse to adjacent downstream nodes. No data is passed over the wire.
// Committed directly to WorkflowContext[nodeId]:
{ "metadata": { "method": "POST", "timestamp": 1711395729 },
  "headers": { "content-type": "application/json" },
  "query": {},
  "body": { ... } }