@orgloop/module-minimal 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# @orgloop/module-minimal
|
|
2
|
+
|
|
3
|
+
Minimal starter module -- 1 webhook source, 1 generic actor, 1 example route. Use this as a starting point to understand OrgLoop's module system or as a template for building your own modules.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
orgloop add module minimal
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## What's Included
|
|
12
|
+
|
|
13
|
+
**Sources (1):**
|
|
14
|
+
- **webhook** -- Generic webhook receiver listening on `/webhook`, emitting `resource.changed` and `message.received` events
|
|
15
|
+
|
|
16
|
+
**Actors (1):**
|
|
17
|
+
- **responder** -- Generic webhook delivery target, posts events to a configurable URL
|
|
18
|
+
|
|
19
|
+
**Routes (1):**
|
|
20
|
+
- **example** -- Forwards `resource.changed` events from the webhook source to the responder actor
|
|
21
|
+
|
|
22
|
+
**SOPs (1):** `example.md`
|
|
23
|
+
|
|
24
|
+
## Parameters
|
|
25
|
+
|
|
26
|
+
| Parameter | Required | Default | Description |
|
|
27
|
+
|-----------|----------|---------|-------------|
|
|
28
|
+
| `source` | yes | `webhook` | Name of the webhook source connector |
|
|
29
|
+
| `actor` | yes | `responder` | Name of the actor connector |
|
|
30
|
+
|
|
31
|
+
## Required Credentials
|
|
32
|
+
|
|
33
|
+
| Variable | Description |
|
|
34
|
+
|----------|-------------|
|
|
35
|
+
| `WEBHOOK_TARGET_URL` | URL where the responder actor delivers events |
|
|
36
|
+
|
|
37
|
+
## Documentation
|
|
38
|
+
|
|
39
|
+
Full documentation at [orgloop.ai](https://orgloop.ai)
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
MIT
|