Parameters required & accepted by all endpoints
| Parameter | Value type | Optional? | Description |
|---|---|---|---|
x-success | string | mostly | Base URL for on-success callbacks, see Getting data back from Actions URI. |
x-error | string | mostly | Base URL for on-error callbacks, see Getting data back from Actions URI. |
debug-mode | boolean | yes | When enabled, Actions URI will include all parameters of the original request in the return calls, prefixed with input-. Defaults to false. |
hide-ui-notice-on-error | boolean | yes | v1.8+ When enabled, the UI notice will not be shown on “note not found” errors etc. Defaults to false. |
Notes about parameters
v1.9+ The vault parameter was removed in v1.9.0 for compatibility with Obsidian 1.13, which no longer passes vault in obsidian:// URIs. It is no longer required; if still supplied, it is silently ignored.
- "mostly"
- optional unless specified otherwise in the detailed route description
- "boolean"
- Actions URI uses what I call "benevolent booleans": the absence of the parameter, an empty string or the string "false" are considered
false, everything else istrue