obsidian-plugin/khabaroff-studio_obsidian-webhooks-server
1
0
Fork 0
mirror of https://github.com/khabaroff-studio/obsidian-webhooks-server.git synced 2026-07-22 07:16:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khabaroff-studio_obsidian-w.../plugin/README.md
Sergei Khabarov 55ee0536ce Prepare plugin for Obsidian Community Plugin Directory submission 
- Rename plugin ID to "webhooks-v2" (no "obsidian" in ID per directory rules)
- Add normalizePath() to file_handler.ts (required by guidelines)
- Add network usage disclosure to README
- Add LICENSE, versions.json, version-bump.mjs
- Add release-plugin.yml workflow (trigger: plugin-* tags)
- Copy manifest.json to repo root (Obsidian validator requirement)
- OpenSpec proposal 021

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-26 15:43:59 +04:00

2 KiB
Raw Permalink Blame History

Webhooks V2

Receive webhooks from external services and create notes in your vault via a self-hosted server with real-time delivery.

Features

  • Real-time delivery via Server-Sent Events (SSE) with polling fallback
  • Exactly-once delivery with acknowledgment (ACK) system
  • Event deduplication prevents duplicate writes
  • Append or overwrite mode for file content
  • Auto-create folders when target path doesn't exist
  • Connection status in the status bar
  • Self-hosted — your data stays on your server

Requirements

  • A running instance of Webhooks Server
  • A client key from the server dashboard

Network usage

This plugin connects to your self-hosted webhook server to receive events via SSE and HTTP polling. All network traffic goes exclusively to the server URL you configure in settings. No data is sent to any third-party service.

Installation

From community plugins

  1. Open Settings > Community plugins > Browse
  2. Search for Webhooks V2
  3. Click Install, then Enable

Manual

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Create a folder webhooks-v2 in your vault's .obsidian/plugins/ directory
  3. Copy the downloaded files into that folder
  4. Enable the plugin in Settings > Community plugins

Usage

  1. Register at your server's dashboard to get a client key
  2. Open plugin settings and paste your client key
  3. Click Test to verify the connection
  4. Send a webhook to your server:
curl -X POST "https://your-server.com/webhook/YOUR_WEBHOOK_KEY?path=inbox/note.md" \
  -H "Content-Type: text/plain" \
  -d "Hello from webhook!"

The content will appear in your vault at the specified path.

Credits

Based on the original obsidian-webhooks plugin by @trashhalo.

License

MIT