obsidian-webhooks-events

name	obsidian-webhooks-events
description	Handle Obsidian events and workspace callbacks for plugin development. Use when implementing reactive features, handling file changes, or responding to user interactions in your plugin. Trigger with phrases like "obsidian events", "obsidian callbacks", "obsidian file change", "obsidian workspace events".
allowed-tools	Read, Write, Edit
version	1.13.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","obsidian","react"]
compatibility	Designed for Claude Code, also compatible with Codex and OpenClaw

Obsidian Webhooks & Events

Overview

Complete guide to Obsidian's event system: vault events (create, modify, delete, rename), workspace events (layout, leaf changes, editor state), metadataCache events, DOM events, custom EventRef patterns, and periodic tasks. Every event registration uses this.registerEvent() for automatic cleanup on plugin unload.

Prerequisites

• Working Obsidian plugin with onload() / onunload() lifecycle
• Understanding of TypeScript event handler signatures
• Familiarity with Obsidian's TFile, TFolder, and WorkspaceLeaf types

Instructions

Step 1: Vault Events — File Lifecycle

Vault events fire when files and folders are created, modified, deleted, or renamed.

import { Plugin, TFile, TFolder, TAbstractFile } from 'obsidian';

export default class EventPlugin extends Plugin {
  async onload() {
    // File created
    this.registerEvent(
      this.app.vault.on('create', (file: TAbstractFile) => {
        if (file instanceof TFile) {
          console.log('New file:', file.path);
          this.(file);
        }
         (file  ) {
          .(, file.);
        }
      })
    );

    
    .(
      ...(,  {
         (file  ) {
          .(file);
        }
      })
    );

    
    .(
      ...(,  {
         (file  ) {
          .(file.);
        }
      })
    );

    
    .(
      ...(,  {
         (file  ) {
          .(oldPath, file.);
        }
      })
    );
  }
}