@ycodium-ai/plugin-webhook-notify 0.1.0 → 0.2.1

package/README.md

@@ -0,0 +1,60 @@
+# @ycodium-ai/plugin-webhook-notify
+
+Send a JSON notification to your webhook when a Ycodium conversation finishes or fails.
+
+## Install
+
+The plugin ships enabled with Ycodium. It stays idle until you configure a URL.
+To install it separately or restore a removed installation:
+
+```sh
+ycodium plugin add @ycodium-ai/plugin-webhook-notify
+```
+
+In **Settings → Plugins → Webhook notifications**, set **Webhook URL** and save.
+Requests run on the connected machine and use its proxy settings. The URL must be reachable
+from that machine.
+
+## Notifications
+
+The plugin sends an HTTP POST with `Content-Type: application/json`:
+
+```json
+{
+  "event": "thread.settled",
+  "threadId": "conversation-id",
+  "summary": "The conversation has finished",
+  "occurredAt": "2026-09-14T00:00:00.000Z",
+  "eventId": "event-id"
+}
+```
+
+`event` is `thread.settled` or `thread.failed`. Use `eventId` to recognize the same event
+if your receiver handles duplicate deliveries.
+
+Requests time out after 10 seconds. Network errors and non-success responses are logged;
+they do not interrupt the conversation. The plugin does not retry failed requests.
+
+## Disable, update, or remove
+
+Clear **Webhook URL** to stop sending notifications while keeping the plugin enabled.
+The plugin's enable switch stops its subscriptions and aborts pending requests.
+Remove it from Settings → Plugins to uninstall it.
+
+Install a specific newer version with:
+
+```sh
+ycodium plugin add @ycodium-ai/plugin-webhook-notify@<version>
+```
+
+The plugin declares no additional permissions. It uses the HTTP and event capabilities
+provided by the host, and requires plugin API version 2.
+
+## Development
+
+The package builds its own code into `dist/index.js`. The host supplies the shared
+`@ycodium-ai/plugin-api` at runtime.
+
+## License
+
+UNLICENSED.

package/dist/index.js

@@ -1,8 +1,5 @@
-// ../../packages/plugin-api/src/index.ts
-var PLUGIN_API_VERSION = 1;
-var definePlugin = (definition) => definition;
-
 // src/index.ts
+import { definePlugin } from "@ycodium-ai/plugin-api";
 var REQUEST_TIMEOUT_MS = 1e4;
 var readUrl = (config) => {
   const value = config["url"];
@@ -18,7 +15,7 @@ var webhookPayload = (event) => ({
 });
 var webhookNotifyPlugin = definePlugin({
   id: "webhook-notify",
-  apiVersion: PLUGIN_API_VERSION,
+  apiVersion: 2,
   activate: (ctx) => {
     const disposeController = new AbortController();
     const notify = async (event) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ycodium-ai/plugin-webhook-notify",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Posts to a URL you choose whenever a thread finishes or fails.",
   "keywords": [
     "webhook",
@@ -19,7 +19,7 @@
     "@effect/vitest": "4.0.0-beta.103",
     "esbuild": "0.28.1",
     "vite-plus": "0.2.2",
-    "ycodium-plugin-api": "0.0.35"
+    "@ycodium-ai/plugin-api": "0.1.1"
   },
   "ycodium": {
     "plugin": "./dist/index.js",