@orgloop/connector-webhook 0.1.0 → 0.1.3

package/README.md

@@ -19,6 +19,7 @@ sources:
     config:
       secret: "${WEBHOOK_SECRET}"        # optional — HMAC-SHA256 secret for signature validation
       event_type_field: "type"           # optional — dot-path to extract event type from payload (default: "type")
+      buffer_dir: "/tmp/orgloop-webhooks"  # optional — persist events to disk
     poll:
       interval: "30s"                    # how often to drain received webhook events
 ```
@@ -27,8 +28,10 @@ sources:
 
 | Field | Type | Required | Default | Description |
 |-------|------|----------|---------|-------------|
+| `path` | `string` | no | — | URL path for this webhook endpoint |
 | `secret` | `string` | no | — | HMAC-SHA256 secret for validating signatures. Supports `${ENV_VAR}` syntax |
 | `event_type_field` | `string` | no | `"type"` | Dot-notation path to extract a platform event type from the incoming JSON payload |
+| `buffer_dir` | `string` | no | — | Directory for buffering received events to disk (JSONL). If set, events survive engine restarts |
 
 ### Events emitted
 
@@ -87,6 +90,9 @@ actors:
       auth:                               # optional — authentication
         type: "bearer"                    # "bearer" or "basic"
         token: "${WEBHOOK_AUTH_TOKEN}"    # for bearer auth (env var ref)
+      body_template:                      # optional — custom payload shape
+        text: "Event {{ event.type }} from {{ event.source }}"
+        data: "{{ event.payload }}"
 ```
 
 #### Target config options
@@ -100,10 +106,11 @@ actors:
 | `auth.token` | `string` | no | — | Bearer token (for `type: "bearer"`). Supports `${ENV_VAR}` |
 | `auth.username` | `string` | no | — | Username (for `type: "basic"`). Supports `${ENV_VAR}` |
 | `auth.password` | `string` | no | — | Password (for `type: "basic"`). Supports `${ENV_VAR}` |
+| `body_template` | `object` | no | — | Template object with `{{ path }}` placeholders (see below) |
 
 ### Delivery payload
 
-The target sends a JSON body containing the full event and the resolved launch prompt:
+By default, the target sends a JSON body containing the full event and the resolved launch prompt:
 
 ```json
 {
@@ -112,6 +119,19 @@ The target sends a JSON body containing the full event and the resolved launch p
 }
 ```
 
+### Body templates
+
+Use `body_template` to customize the outbound payload shape. Template strings support `{{ path }}` placeholders resolved against the event context:
+
+```yaml
+body_template:
+  text: "New event from {{ event.source }}: {{ event.type }}"
+  channel: "#alerts"
+  payload: "{{ event.payload }}"
+```
+
+Available template variables: `event` (the full event object), `launch_prompt` (the route's resolved prompt).
+
 ### Delivery results
 
 | HTTP Status | Result |
@@ -144,7 +164,6 @@ routes:
 
 ## Limitations / known issues
 
-- **Source is push-based** -- Events are buffered in memory until the next `poll()` call drains them. A crash between receipt and poll loses events.
+- **Source is push-based** -- By default, events are buffered in memory until the next `poll()` call drains them. Configure `buffer_dir` to persist events to disk and survive restarts.
 - **No batching** -- The target sends one HTTP request per event.
-- **No custom body templates** -- The target always sends `{ event, launch_prompt }`. For custom payload shapes, use a transform before delivery.
 - **Nested event type extraction** -- The `event_type_field` supports dot-notation (e.g., `"data.event_type"`) for extracting the platform event type from deeply nested payloads.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@orgloop/connector-webhook",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "OrgLoop generic webhook connector — inbound and outbound",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@orgloop/sdk": "0.1.0"
+    "@orgloop/sdk": "0.1.3"
   },
   "orgloop": {
     "type": "connector",