<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[`Plugin`](Plugin) › [`registerObsidianProtocolHandler`](Plugin/registerObsidianProtocolHandler)
## Plugin.registerObsidianProtocolHandler() method
Register a handler for obsidian:// URLs.
**Signature:**
```typescript
registerObsidianProtocolHandler(action: string, handler: ObsidianProtocolHandler): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| <code>action</code> | <code>string</code> | the action string. For example, 'open' corresponds to <code>obsidian://open</code>. |
| <code>handler</code> | [`ObsidianProtocolHandler`](ObsidianProtocolHandler) | the callback to trigger. A key-value pair that is decoded from the query will be passed in. For example, <code>obsidian://open?key=value</code> would generate <code>{'action': 'open', 'key': 'value'}</code>. |
**Returns:**
`void`
Not found
This page does not exist