Notebooks URL Schemes
Notebooks offers support for a range of URL schemes, which are essentially URLs that enable communication between Notebooks and other apps. You can also use these schemes in Shortcuts, and any place that supports clickable links. This allows you to automate various tasks and integrate Notebooks with other apps more seamlessly.
It’s important to percent escape these URLs, which involves replacing certain characters to ensure the URL is valid. The most common character requiring replacement is the space character, which must be replaced with %20.
Open a Specific Document
notebooks://show/escaped%20path%20to%20document
notebooks://escaped%20path%20to%20document
This URL opens the referenced document in Notebooks. The path is relative to Notebooks‘ root and should be URL-espaced. Notebooks uses this format for its internal links.
Add Text as a New Plain Text Document
notebooks://addnote/note%20body&title=Title%20is%20optional&parent=path%20to%20parent
notebooks://addnote/note%20body&title=title%20for%20document
notebooks://addnote/note%20body
This scheme adds new documents to Notebooks‘ top level. When used without title, Notebooks assigns the first line of the text as title. – This is a simple and convenient option for other apps to send documents to Notebooks.
Search in Notebooks
notebooks://search/term%20to&20search%for&scope=book/to/search
notebooks://search/term%20to&20search%for
The search URL scheme opens Notebooks and triggers a search for the given term. You can add an optional path to a book to restrict the search scope.
Create a New Document
notebooks://addNewDoc&parent=path%20to%20parent
notebooks://addNewDoc
This creates a new document ready for you to start adding text. If you provide a valid parent, Notebooks creates the document within that book, otherwise it will appear at the top level of Notebooks.
Notebooks uses the default document type for the new document. You can change the default type in Settings.
Create a New Task
notebooks://addNewTask&parent=path%20to%20parent
notebooks://addNewTask
Create a new task. When a valid parent given, Notebooks creates the task in that book. Otherwise Notebooks uses the specified default Inbox. When no default in box is set, Notebooks will display an alert.
Create a New Sketch
notebooks://addNewSketch&parent=path%20to%20parent
notebooks://addNewSketch
Create an empty PDF document (this is what Notebooks’ sketches are based on) and open it in edit mode. With an Apple Pencil, you can immediately start drawing.
Append Text to a Document
notebooks://append/text%20to%20add&doc=path%20to%20document.txt
Use this scheme to append text to an existing document at the specified path. Notebooks assumes that the document exists and treats the appended text as plain text (Markdown works as well).
Import from a URL
notebooks://grab/URL&title=Title%20of%20document
notebooks://grab/URL&title=Title%20of%20document&parent=Path%20to%20target%20book
notebooks://grab/URL
This URL scheme allows you to import a document by providing its URL. This is actually what the Notebooks bookmarklet does. Additionally, you can specify the title for the imported document and the location where it should be stored within Notebooks.
Start WiFi Sharing (iPhone and iPad)
notebooks://wifi_sharing
notebooks://wifi_sharing/Path%20To%20Book%20To%20Share
This scheme starts WiFi Sharing at the selected book. If the book does not exist, Notebooks displays a message, but does not start sharing. – When no book is specified, sharing starts at Notebooks‘ top level.
Start WebDAV Sync (iPhone and iPad)
notebooks://webdav_sync
notebooks://webdav_sync/Path%20To%20Book%20To%20Sync
This scheme initiates a WebDAV sync (if set up) starting at the specifed book. If the book does not exist, Notebooksdisplays a warning message, but does not start sync.
When no book is given, synchronization starts at Notebooks‘ top level.